优秀代码注释的5个技巧
来源:互联网 发布:protobuf java 编辑:程序博客网 时间:2024/05/17 09:13
别以为你可以理解自己写的代码,过了两个星期之后,你可能就不知道代码是不是自己写的。
如果是简单的代码,不加注释情有可原,但是,复杂的代码那就必须加注释了。
1、代码注释最基本的原则
代码注释一定是注明代码的目的,而不是代码的行为。为何呢?因为通过代码我们就可以清楚行为,多加注释,画蛇添足。
2、使用空格对齐注释行
为了方便阅读起见,代码注释对齐会更好一些。那么问题来了,是用tab对齐还是用空格键对齐呢?
我们都清楚,tab在不同的编辑器和集成开发环境中是不一样的,所以选择空格键对齐会适合一些。
const MAX_ITEMS = 10; // maximum number of packets
const MASK = 0x1F; // mask bit TCP
3、代码少而精
如果说代码注释一定要有,那就就要尽量做到少而精。有些人代码注释写的跟小说一样,这后果是相当严重的...
4、代码“统帅”段落
一些程序员习惯将代码分成多个“段落”,这是非常要好的一个习惯。当然,加个代码注释就会锦上添花。比如在段落代码前加个注释。同样地,就是告诉自己或者维护人员代码的意图。
5、代码注释的精髓
阅读全文
0 0
- 优秀代码注释的5个技巧
- 10个最“优秀”的代码注释
- 10个最“优秀”的代码注释
- 10个最“优秀”的代码注释
- 10个最“优秀”的代码注释
- 10个最“优秀”的代码注释
- 10个最“优秀”的代码注释
- 10个最“优秀”的代码注释
- 10个最“优秀”的代码注释
- 10个最“优秀”的代码注释
- 10个最“优秀”的代码注释
- 10个最“优秀”的代码注释
- 10个最“优秀”的代码注释
- 10个最“优秀”的代码注释
- 10个最“优秀”的代码注释
- 10个最“优秀”的代码注释
- 10个最“优秀”的代码注释
- 编写优秀代码的10个技巧
- 知识、见识和认知
- 51 nod 1421 最大mod值 思维题
- 通过npm写一个cli命令行工具
- 15年编程生涯,资深架构师总结的7条经验
- express路由模块化
- 优秀代码注释的5个技巧
- 【小程序】调用wx.request接口时需要注意的几个问题
- Java设计模式_(行为型)_备忘录模式
- This incident will be reported
- 这样操作就不会出现cad转换成jpg不清楚
- 侧滑菜单DrawerLayout的使用
- DEVICE_ATTR的使用
- GitHub 12个小技巧
- 十分钟入门 Angular4(一)