分享
 
 
 

如何写注释

王朝java/jsp·作者佚名  2006-01-09
窄屏简体版  字體: |||超大  

介绍你一个小知识吧(说是小知识,不过关系重大)

就是如何写注释.以往我一直都比较困惑注释到底要写些什么,常常注释了很多,可是回头看的时候却发现注释一点信息量也没有

一般我们所说的注释都是针对函数(也就是方法),因为函数是模块化设计的最小单元(类还不算最小单元)

一个函数意味着一个功能,所以,函数的注释至少要有两条:

1.这个函数在什么情况下可以得到正确的运行结果,比如开平方的函数,参数不能为负数.

这个叫做'前导条件',建议在方法的开头注明,像这样 :

void xxx() {

//pre : 前导条件

}

不是所有的函数都具有前导,有的函数可以在任何情况下得到正确结果,比如加法之类的.

所以,有时候,前导条件可以省略不写

2.这个函数执行之后会造成什么影响.比如设置对象的某个状态或者返回某一个值.

这个叫做'后置条件',建议在方法的结尾注明,像这样 :

void xxx() {

....

//post : 后置条件

}

所有的函数都具有后置条件.因为一个函数被调用之后肯定会造成影响,否则这个函数就没有存在地意义.

一定要写明每一个函数的后置条件.

3.函数当中如果用到了公式或者定理,要在注释当中用了那条定理或者公式,最好能付上公式或者定理的简要说明.(当然,如果是勾股定理这种简单的,不说也可以)

4.如果某一段代码是顺序不能颠倒的,要注明,像这样:

...;

#隔一行

//处理XXX

//sequence dependent

//1st : xxx

....;

//2nd : xxx

...;

//3rd : xxx

...;

#隔一行

.....

注意了这几点,应该就不会再遇到不知道该注释什么,或者注释中尽是废话(我常常这样) 的问题了.

注意 : 在写代码的时候写的注释才有价值,如果在代码已经写完才来补注释,那么就不要再补了,把要写的写进文档就可以.

注释要求记录程序员写程序时候的思维过程

这里提到的只是我个人的编码习惯,主要是介绍一下写注释需要注意的一些细节.

 
 
 
免责声明:本文为网络用户发布,其观点仅代表作者个人观点,与本站无关,本站仅提供信息存储服务。文中陈述内容未经本站证实,其真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。
2023年上半年GDP全球前十五强
 百态   2023-10-24
美众议院议长启动对拜登的弹劾调查
 百态   2023-09-13
上海、济南、武汉等多地出现不明坠落物
 探索   2023-09-06
印度或要将国名改为“巴拉特”
 百态   2023-09-06
男子为女友送行,买票不登机被捕
 百态   2023-08-20
手机地震预警功能怎么开?
 干货   2023-08-06
女子4年卖2套房花700多万做美容:不但没变美脸,面部还出现变形
 百态   2023-08-04
住户一楼被水淹 还冲来8头猪
 百态   2023-07-31
女子体内爬出大量瓜子状活虫
 百态   2023-07-25
地球连续35年收到神秘规律性信号,网友:不要回答!
 探索   2023-07-21
全球镓价格本周大涨27%
 探索   2023-07-09
钱都流向了那些不缺钱的人,苦都留给了能吃苦的人
 探索   2023-07-02
倩女手游刀客魅者强控制(强混乱强眩晕强睡眠)和对应控制抗性的关系
 百态   2020-08-20
美国5月9日最新疫情:美国确诊人数突破131万
 百态   2020-05-09
荷兰政府宣布将集体辞职
 干货   2020-04-30
倩女幽魂手游师徒任务情义春秋猜成语答案逍遥观:鹏程万里
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案神机营:射石饮羽
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案昆仑山:拔刀相助
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案天工阁:鬼斧神工
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案丝路古道:单枪匹马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:与虎谋皮
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:李代桃僵
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:指鹿为马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:小鸟依人
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:千金买邻
 干货   2019-11-12
 
推荐阅读
 
 
 
>>返回首頁<<
 
靜靜地坐在廢墟上,四周的荒凉一望無際,忽然覺得,淒涼也很美
© 2005- 王朝網路 版權所有