java中的注释分:
实现注释和文档注释。实现注释和在C语言里的一样,采用/*....*/ 和 // 进行的注释;
而文档的注释应该说是java里面独有的,采用的是/**....*/,Sun公司开发的Javadoc工具可以识别出这类文档注释将其转化成HTML文件。
下面先看文档注释。
文件注释:写在文件头部,包名之前的位置。范例如下。
/**
* 文件名:TestCode.java
* 版权:Copyright 2014-2015 IBM.All Rights Reserved.
* 描述: xxxxxxxx
* 修改人:xxx
* 修改时间:2014-5-12
* 修改内容: xxxxxxx
* /
2.类和接口的注释:放在package关键字之后,Class/Interface关键字之前。范例如下。
/**
*
* 注释内容
* */
3.第2条中注释内容的格式:用一句话进行功能描述,根据需要列出:版本号、生成日期、作者、内容、功能、与其他类的关系等。如果类里存在bug,请如实说明这些bug。范例如下。
/**
* (一句话功能简述)
* (功能详细描述)
* @author WangWu
* @version[版本号,YYYY-MM-DD]
* @see[相关类/方法]
* @since[产品/模块版本]
*/
注:@since表示从那个版本开始就有这个类或者接口
4.类、方法属性:共有、保护、私有的注释,写在类、方法声明之前。范例如下。
/**
* 注释内容 */
private void write() {
}
5.在4中的注释内容为:列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例等。范例如下。
/**
* (一句话功能简述)
* <功能详细描述>
* @param [参数1][参数1说明]
* @param [参数2][参数2说明]
* @return[返回类型说明]
* @exception/throws[违例类型][违例说明]
* @see
*/