如何写注释

2016-02-19 14:30 10 1 收藏

下面,图老师小编带您去了解一下如何写注释,生活就是不断的发现新事物,get新技能~

【 tulaoshi.com - 编程语言 】

  介绍你一个小知识吧(说是小知识,不过关系重大)
  就是如何写注释.以往我一直都比较困惑注释到底要写些什么,经常注释了很多,可是回头看的时候却发现注释一点信息量也没有

  一般我们所说的注释都是针对函数(也就是方法),因为函数是模块化设计的最小单元(类还不算最小单元)
  一个函数意味着一个功能,所以,函数的注释至少要有两条:
  1.这个函数在什么情况下可以得到正确的运行结果,比如开平方的函数,参数不能为负数.
    这个叫做'前导条件',建议在方法的开头注明,像这样 :
  void xxx() {
     //pre : 前导条件
  }
    不是所有的函数都具有前导,有的函数可以在任何情况下得到正确结果,比如加法之类的.
    所以,有时候,前导条件可以省略不写
  2.这个函数执行之后会造成什么影响.比如设置对象的某个状态或者返回某一个值.
    这个叫做'后置条件',建议在方法的结尾注明,像这样 :
  void xxx() {
    ....
    //post : 后置条件
  }
    所有的函数都具有后置条件.因为一个函数被调用之后肯定会造成影响,否则这个函数就没有存在地意义.
    一定要写明每一个函数的后置条件.
  3.函数当中假如用到了公式或者定理,要在注释当中用了那条定理或者公式,最好能付上公式或者定理的简要说明.(当然,假如是勾股定理这种简单的,不说也可以)
  4.假如某一段代码是顺序不能颠倒的,要注明,像这样:
     ...;
     #隔一行
     //处理XXX
     //sequence dependent
     //1st : xxx
     ....;
     //2nd : xxx
     ...;
     //3rd : xxx
     ...;
     #隔一行
     .....

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

(本文来源于图老师网站,更多请访问http://www.tulaoshi.com/bianchengyuyan/)

  注重 : 在写代码的时候写的注释才有价值,假如在代码已经写完才来补注释,那么就不要再补了,把要写的写进文档就可以.
  注释要求记录程序员写程序时候的思维过程
  
  这里提到的只是我个人的编码习惯,主要是介绍一下写注释需要注重的一些细节.

(本文来源于图老师网站,更多请访问http://www.tulaoshi.com/bianchengyuyan/)


来源:http://www.tulaoshi.com/n/20160219/1607092.html

延伸阅读
标签: 怀孕
休产假申请书如何写?格式示范1 休产假申请书尊敬的公司领导: 因本人有孕在身,预产期2008年11下旬,现需要回家休息,调养身体。特向领导申请办理请假手续,春节后回来上班(从2008年5月1日至2009年2月1日)请假时间为10个月。目前本岗位的工作已移交给XXX同志。另在此非常感谢公司领导对我的关心和照顾,真正体现了人文化主义。 特此申请,望...
标签: 职场
会计职业生涯是海,没有规划的会计人生,好比在大海中航行没有指南针,会计职业规划尤其对于学会计的大学生,大学生会计的职业规划很重要,那么会计职业生涯规划如何写?下面给大家分析一下。 会计职业生涯规划是决定大学生走上工作岗位,在会计职业生涯中是低头走路还是抬头走路的问题。一个好会计一生中必须学好会计、财务、税务、管...
手机QQ空间小秘密如何写私信?   手机QQ空间小秘密如何写私信。每个人都有一点小秘密,想说又不能说的时候是最痛苦的,可是自从手机QQ空间增加了小秘密匿名之后就有很多人去那里诉说自己的小秘密,里面可以聊天点赞哦,只是大家都不知道对方是谁,但是可以对话,现在都可以聊私信啦,不过还是匿名私信呢,怎么样?现在就跟小编一起看看...
标签: 职场 离职证明
填写简历时,离职原因怎么写?下面就来解析一下如何写好离职原因: 一、切忌说公司的不好。 其实,我们都心知肚明,离职的很大一部分原因是因为公司。可能是薪水太低,可能是没有发展前景,可能是遇到一个奇葩上司······但是,我们离职的时候,千万不要说公司的不好。因为,这么写的话会给面试官留下不好的印象,哪个公司没...
标签: Web开发
JavaScript的动态效果最基本的是 动态改变大小,移动位置,改变透明度,改变颜色等等。 而其他一些比较炫的效果无非是对这些最基本效果的组合和运用。 现在网上已经有很多很不错的优秀Javascript库或者效果库,我们是否有必要再造轮子呢? 放眼望去,Yahoo UI, 基于Prototype的scriptaculous, Rico, JQuery, ...

经验教程

270

收藏

7
微博分享 QQ分享 QQ空间 手机页面 收藏网站 回到头部