在理想的情况下，代码不需要注释。理想的代码，命名恰当，结构清晰，逻辑顺畅，含义显而易见。
1.因为注释不需要运行，所以没有常规的办法来测试它。注释难以维护，这是使用注释带来最大的麻烦。
2.注释为我们提供了一个借口。我们有时候会过度依赖注释，从而放弃了潜在的替代方案，比如更准确的命名，更清晰的结构，更顺畅的逻辑等等。注释，被我们用成了狗皮膏药，有时会让代码更糟糕。
3.注释的滥用
1.记录源代码版权和授权的
2.用来生成的用户文档的
用来生成独立的，不包含源代码的文档。这些文档帮助使用者了解软件的功能和细节，主要面向该软件的使用者，而不是该软件的开发者。
3.解释源代码的
帮助代码的阅读者理解代码。
1.周期 ，错误的注释比没有注释更糟糕
2.必要，多余的注释浪费阅读者时间
3.清晰 混乱的注释会把代码搞得更乱
注释用英文还是中文？
推荐英文注释，在国际化项目中，没有办法使用中文。
https://time.geekbang.org/column/article/78086
注释是无奈的妥协 在理想的情况下，代码不需要注释。理想的代码，命名恰当，结构清晰，逻辑顺畅，含义显而易见。 注释带...
07-15 1.Html的结构 我是标题 2....
虚境朝拾：与敌方监视者博弈 2019/04/12 07:00-08:00左右 场景1： （注释：07:00-08:...
西哥一看阎荣惜真的生气了，就连忙追上她说：“小惜，小惜，你别生气嘛！不就破个风水吗？对哥来说还不是小菜一碟。” “...
title:LaTeX日语汉字假名注释date: 2020/07/18 周六 11:32:31.28tags:...
“面具”的百度注释是：起遮挡保护作用的外罩。 可是“面具”真的是保护我们的吗？这是把双刃剑啊！ 我曾经也认为面...
这是真的吗？这真的是真的吗？这100%是真的吗
见识多，人就会更平和，少生气，是真的吗？
央视财经频道有一档节目，叫作“是真的吗”，节目选取了网友质疑最多的问题进行科学实验验证，辨别真假，粉碎谣言。黄西搞...
是真的吗，是大型求证类节目。这个节目告诉了我很多我所不知道的的知识，例如:脑电波能否控制小车前进，有些不清楚事实的...
本文标题：07 注释，真的是小菜一碟吗？
本文链接：https://www.haomeiwen.com/subject/evcveltx.html
网友评论