写代码时加注释是为了提高代码可读性，方便自己和他人理解。应在关键地方添加注释，单行注释（//）适合解释单行代码或变量作用，如说明逻辑目的、调试屏蔽代码；多行注释（/ /）适合完整说明函数用途、参数含义及注意事项，并可用于临时屏蔽代码段；注释应清晰实用，避免重复代码内容、不相关背景或过时信息，应说明“为什么”而非仅“做了什么”，并标明公共函数的输入输出及副作用；选择单行或多行注释取决于内容长度与上下文需求，html/css中只能使用多行注释；团队开发中应遵循统一规范，保持风格一致。
写代码时加注释，是让自己和别人以后更容易看懂这段代码在干什么。很多人一开始写代码都不太注意注释，结果回过头来看自己写的代码都得想半天。其实只要在关键地方加上几句说明，就能省掉很多理解成本。
什么时候该用单行注释（//）
单行注释适合写在某一行代码的上方或后面，用来解释这行代码做了什么。它的优点是简洁，不会显得累赘。
比如：
// 计算总价并保留两位小数const totalPrice = (price * quantity).toFixed(2);
或者像这样写在代码后面：
let count = 0; // 初始化计数器
适用场景：
解释某个变量的作用说明某段逻辑的目的暂时屏蔽某行代码（调试时常用）
这种写法特别适合在函数内部、逻辑分支里做简单说明，不需要大段文字也能让人一目了然。
多行注释（/ /）更适合哪些情况
多行注释适合写一段比较完整的说明，比如函数用途、参数含义、注意事项等。它不会打断代码结构，适合写稍长一点的解释。
比如：
/* * 获取用户信息 * 参数： * userId: 用户唯一标识符 * 返回值： * 包含用户名和邮箱的对象 */function getUserInfo(userId) { // ...}
也可以临时把一段代码“注释掉”来测试效果：
/*console.log('调试信息');fetchData();*/
不过要注意的是，在有些语言中（比如HTML、CSS），只能使用多行注释，不能用//。
注释也要讲究清晰和实用
写注释不是为了凑字数，而是要写出真正有用的信息。比如下面这些做法就不太合适：
注释内容和代码重复：“设置标题”写在title = '首页'旁边写一堆不相关的背景故事忘记更新注释，导致注释和实际代码不符
好注释的标准：
简洁明确，不说废话解释“为什么”，而不是“做了什么”如果是公共函数，说明输入输出和副作用
比如这样写更好：
// 需要先转成整数，防止字符串拼接出错const num = parseInt(inputValue, 10);
单行还是多行？看场景选就好
没有绝对正确的选择，主要看你要表达的内容长度和上下文是否需要。一般来说：
想说一句两句，用//要写个说明文档式的注释，用/* */在不同语言中也略有差异，比如HTML/CSS只能用多行注释
另外，团队有统一规范的话，按规范来就行。如果没有，保持一致风格也很重要。
基本上就这些。写注释不是难事，但确实容易被忽略。花点时间写清楚，回头省不少麻烦。
以上就是如何注释代码？使用//单行或/* */多行注释的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/1464102.html
微信扫一扫 
支付宝扫一扫 
