如何写注释
介绍你一个小知识吧(说是小知识,不过关系重大)
就是如何写注释.以往我一直都比较困惑注释到底要写些什么,经常注释了很多,可是回头看的时候却发现注释一点信息量也没有
一般我们所说的注释都是针对函数(也就是方法),因为函数是模块化设计的最小单元(类还不算最小单元)
一个函数意味着一个功能,所以,函数的注释至少要有两条:
1.这个函数在什么情况下可以得到正确的运行结果,比如开平方的函数,参数不能为负数.
这个叫做'前导条件',建议在方法的开头注明,像这样 :
void xxx() {
//pre : 前导条件
}
不是所有的函数都具有前导,有的函数可以在任何情况下得到正确结果,比如加法之类的.
所以,有时候,前导条件可以省略不写
2.这个函数执行之后会造成什么影响.比如设置对象的某个状态或者返回某一个值.
这个叫做'后置条件',建议在方法的结尾注明,像这样 :
void xxx() {
....
//post : 后置条件
}
所有的函...[ 查看全文 ]
