码迷,mamicode.com
首页 > 其他好文 > 详细

《编写可读代码的艺术》《第5章 该写什么样的注释》

时间:2020-01-11 18:24:06      阅读:72      评论:0      收藏:0      [点我收藏+]

标签:Fix   hack   无法   思想   技术   编写可读代码的艺术   code   info   运行   

1. 了解什么不需要注释

2. 用代码记录你的思想

3. 站在读者的角度,去想象他们需要知道什么

好代码 > 坏代码 + 注释

 

为代码中的瑕疵写注释:

TODO: 我还没有处理的事情

FIXME: 已知的无法运行的代码

HACK: 对一个问题不得不采用的比较粗糙的解决方案

XXX: 危险,这里有重要的问题

 

给常量加注释

技术图片

技术图片

技术图片

《编写可读代码的艺术》《第5章 该写什么样的注释》

标签:Fix   hack   无法   思想   技术   编写可读代码的艺术   code   info   运行   

原文地址:https://www.cnblogs.com/focus-z/p/12180618.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!