注释是一种必须的恶。注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败
程序存在的时间越久，注释的可信度、可读程序就很低。作者认为，程序员虽然有保持注释精读的责任，但是更应该做的是整理代码，减少注释，注释过多往往是一种程序“腐化的坏味道”。
不可省略的涉及到法律的信息 豹：比如开源协议。
提供信息的注释
对意图进行解释 豹：对某些可以选择的实现决定进行解释。
警示 豹：这里指的是一些特定行为的代码的注释。比如某个测试可能会运行很长时间之类的注释。
...
喃喃自语： 这种情况大量存在，属于程序员的只说自话，基本是垃圾代码的借口或者错误决策的修正。
多余的注释 ： 大量存在，没有什么意义的废话注释。
误导性注释 ：不够精确或者干脆写错了
循规试注释 ：指的是应文档化工具的需求就添加的本来不需要注释的注释。
日志试注释 ：指的是本代码文件的修改历史类，将每天的修改记录写上，这完全没有必要，可以被现代源码管理工具取代。它影响了代码阅读。
废话注释
能用函数或者变量的时候就不用注释
第四章 ：函数与模块 定义函数：def 函数注释文档 上面这种函数注释可以，下面这种函数注解是针对python3的...
第四章：Android应用调试 故意制造bug，比如注释掉某个view的findViewById方法。就会闪退。 ...
核心观念 注释是一种必须的恶。注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败 注释会撒谎。 程序存在的时间越...
注释 1 注释 2 注释3 注释4 注释5 注释6 注释7 注释8 注释9 注释10 注释11 注释12 注释13...
第四章 和光同尘 第一节 【原文】 道冲①，而用之或不盈②。渊③兮，似万物之宗④。 【注释】 ①冲：通盅（zhon...
第四章和光同尘 第一节 【原文】 道冲①，而用之或不盈②。渊③兮，似万物之宗④。 【注释】 ①冲：通盅（zhong...
单个注释 使用注释函数进行注释 空白注释 分组注释 点的注释 线条注释 柱状图注释 箱式图注释 条形图注释 密度图...
单行注释、多行注释与文档注释的合理使用 单行注释、多行注释与文档注释的合理使用 单行注释：// 注释内容 多行注释...
代码注释 单行注释在注释前加上"//" 多行注释在注释前使用/*在注释后使用*/ 文档注释注释前后/***/ 变量...
iOS注释规范&&提高注释效率 iOS注释主要分为以下几种：属性注释、方法集注释、方法注释、普通注释（单行注释）。...
本文标题：第四章 注释
本文链接：https://www.haomeiwen.com/subject/bvnrrxtx.html
网友评论