码迷,mamicode.com
首页 > 其他好文 > 详细

程序注释

时间:2015-11-07 09:34:09      阅读:132      评论:0      收藏:0      [点我收藏+]

标签:

1.注释的坏处

  注释阐述的行可能与代码执行的行为不一致。

2.要用到注释的地方

   法律声明;

  代码的意图;

   警告,;

  信息的注释;

  阐释,对方法的参数进行描述;

3.注释注意的地方

   写注释时,最好要把注释写清楚,能在一个地方就能把目的写明白。

   注释时只提供有用的信息

   不要出现位置标记。

   不要出现日志注释,该注释的信息应该交给版本控制器。

   不要出现注释的代码

   显而易见的地方就不要加注释

4.注释代码时,用/** 注释的句子 */

 

程序注释

标签:

原文地址:http://www.cnblogs.com/kejian/p/4944490.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!