现在的位置: 首页 > 综合 > 正文

注释的风格 摘自《代码大全》

2019年03月22日 ⁄ 综合 ⁄ 共 217字 ⁄ 字号 评论关闭

好的注释

1.重复代码的注释根本没用

2.像书的标题或目录

3.注释帮我找到需要的地方,然后我再开始读代码

4.读一句注释比分析20行代码快多了

代码标记

要规范代码标记,如 //待改===

ysmz4:规定标记中必须含===

怎么写好的注释

减少重复性注释,增加概述代码,目的性注释


注释风格

去掉难以维护的注释风格,比如代码改了之后,注释至少不会让人觉得太麻烦,不愿意改

减少行尾注释

减少行尾注释,因为行尾注释不易于维护(还要对齐)

不要对单行代码做行尾注释

抱歉!评论已关闭.