【随笔】代码注释风格

注释风格影响代码可读性

冗余的注释就等于涂鸦

对比

最佳实践

注释不应当用于说明算法
注释只应当用于说明算法的某一个部分
意图不属于算法
总说比分说好/Conclusion is better than declusion.

参考《程序设计实践》

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
平台声明：文章内容（如有图片或视频亦包括在内）由作者上传并发布，文章内容仅代表作者本人观点，简书系信息发布平台，仅提供信息存储服务。

推荐阅读更多精彩内容

  • Android - 收藏集
    Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 173,033评论 25赞 708
  • 代码规范
    推荐文章：禅与 Objective-C 编程艺 前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、...
    WolfTin阅读 2,807评论 0赞 1
  • iOS代码规范
    iOS编程规范0规范 0.1前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、可靠、可 测试、高效...
    iOS行者阅读 4,496评论 21赞 35
  • 秋咏
    二零一七年八月七日，即丁酉年闰六月十六，二十四节气之十三：立秋，太阳到达黄经135度。《月令七十二候集解》...
    嶒經哋嶒經阅读 428评论 0赞 0
  • （产品软文）石头森林的冰冷夜色中寻找温暖光亮
    尽管已是暮色四合，油柏路面上炽热的温度也逐渐退散开来，但在深圳这座高楼林立的石头森林中，发达城市急遽的节奏却并未因...
    傅小光阅读 443评论 0赞 3