A股上市公司传智教育(股票代码 003032)旗下技术交流社区北京昌平校区

 找回密码
 加入黑马

QQ登录

只需一步,快速开始

© 一世英明 中级黑马   /  2014-4-3 15:15  /  1606 人查看  /  2 人回复  /   0 人收藏 转载请遵从CC协议 禁止商业使用本文

1 背景:
1.当我们第一次接触某段代码,但又被要求在极短的时间内有效地分析这段代码,我们需要什么样的注释信息?
2.怎么样避免我们的注释冗长而且凌乱不堪呢?
3.在多人协同开发.维护的今天,我们需要怎么样的注释来保证高质,高效的进行卡法和维护工作呢?


2.意义:
程序中的注释是程序设计者与程序阅读者之间通信的重要手段.应用注释规范对于
软件本身和软件开发人员而言尤为重要.并且在流行的敏捷开发思想中已经提出了将注释
转为代码的概念!
  好的注释规范可以尽可能的减少一个软件的维护成本,并且几乎没有任何一个软件,在其
整个生命周期中,均由最初的开发人员来维护.
  好的注释规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码.
  好的注释规范可以最大限度的提高团队开发的合作效率.
  长期的规范性编码还可以让开发人员养成良好的编码习惯,甚至锻炼出更加严谨的思维能力;




2 个回复

倒序浏览
嘿嘿,强烈统一,必须注释,当前我自己写的一个程序,感觉牛的不行,三天后,愣是看不懂了。
java注释有详解:
1、单行(single-line)--短注释://……   
单独行注释:在代码中单起一行注释, 注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。
注释格式:/* 注释内容 */

行头注释:在代码行的开头进行注释。主要为了使该行代码失去意义。
注释格式:// 注释内容
   
行尾注释:尾端(trailing)--极短的注释,在代码行的行尾进行注释。一般与代码行后空8(至少4)个格,所有注释必须对齐。
注释格式:代码 + 8(至少4)个空格 + // 注释内容
2、块(block)--块注释:/*……*/
注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描述。一般位于一个文件或者一个方法的前面,起到引导的作用,也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成:
/*
  * 注释内容
  */
3、文档注释:/**……*/
注释若干行,并写入javadoc文档。每个文档注释都会被置于注释定界符
/**......*/之中,注释文档将用来生成HTML格式的代码报告,所以注释文
档必须书写在类、域、构造函数、方法,以及字段(field)定义之前。注释文档由两部分组成——描述、块标记。注释文档的格式如下:
/**
* The doGet method of the servlet.
* This method is called when a form has its tag value method
   * equals to get.
* @param request
*  the request send by the client to the server
* @param response
*  the response send by the server to the client
* @throws ServletException
*  if an error occurred
* @throws IOException
*  if an error occurred
*/
public void doGet (HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
    doPost(request, response);
}
前两行为描述,描述完毕后,由@符号起头为块标记注释。更多有关文档注
释和javadoc的详细资料,参见javadoc的主页: http://java.sun.com/javadoc/index.html
4、javadoc注释标签语法
@author    对类的说明 标明开发该类模块的作者
@version   对类的说明 标明该类模块的版本
@see      对类、属性、方法的说明 参考转向,也就是相关主题
@param    对方法的说明 对方法中某参数的说明
@return    对方法的说明 对方法返回值的说明
@exception  对方法的说明 对方法可能抛出的异常进行说明
回复 使用道具 举报
仅供参考!!

JAVA代码注释规则.zip

4.25 KB, 下载次数: 66

JAVA代码注释规范2.zip

6.48 KB, 下载次数: 67

java代码注释规范1.zip

11.16 KB, 下载次数: 71

回复 使用道具 举报
您需要登录后才可以回帖 登录 | 加入黑马