Java注释规范,很详细,很有用。
工程名;类(模块)编号;命名空间;类可以运行的JDK版本;版本号;作者;创建时间;类(模块)功能描述(如功能、主要算法、内部各部分之间的关系、该类与其类的关系等,必要时还要有一些如特别的软硬件要求等说明);主要函数或过程清单及本类(模块)历史修改记录等。
英文注释模版:
/**
* CopyRright (c)2008-xxxx: <展望软件Forsoft >
* Project: <项目工程名 >
* Module ID: <(模块)类编号,可以引用系统设计中的类编号>
* Comments: <对此类的描述,可以引用系统设计中的描述>
* JDK version used: <JDK1.6>
* Namespace: <命名空间>
* Author: <作者中文名或拼音缩写>
* Create Date: <创建日期,格式:YYYY-MM-DD>
* Modified By: <修改人中文名或拼音缩写>
* Modified Date: <修改日期,格式:YYYY-MM-DD>
* Why & What is modified <修改原因描述>
* Version: <版本号>
*/
如果模块只进行部分少量代码的修改时,则每次修改须添加以下注释:
//Rewriter
//Rewrite Date:<修改日期:格式YYYY-MM-DD> Start1:
/* 原代码内容*/
//End1:
将原代码内容注释掉,然后添加新代码使用以下注释:
//Added by
//Add date:<添加日期,格式:YYYY-MM-DD> Start2:
//End2:
如果模块输入输出参数或功能结构有较大修改,则每次修改必须添加以下
注释:
Java注释规范整理_IT/计算机_专业资料。Java注释规范Java 注释规范一、背景 1、当我们第一次接触某段代码,但又被要求在极短的时间内有效地分 析这段代码,我们...
java注释书写规范_IT/计算机_专业资料。Java 注释书写规范 Javadoc 是 Sun 公司提供的一个技术,它从程序源代码中抽取类、方法、成 员等注释形成一个和源代码...
java注释规范_IT/计算机_专业资料。javadoc 做注释 一. Java 文档 // 注释一行 /* ... */ 注释若干行 /** ... */ 注释若干行,并写入 javadoc 文档...
java注释规范_IT/计算机_专业资料。JAVA注释规范设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开 Comments 节点就是所有需设置...
Java注释规范_电子/电路_工程科技_专业资料。Java的各种注释,以及写入Javadoc的注释要求对于Java 注释我们主要了解两种: // 注释一行 /* ... */ 注释若干行...
java注释规范_工学_高等教育_教育专区。Java 程序有两类注释:实现注释(implementation comments)和文档注释(document comments)。 实现注释:/*…*/和//,用以注释...
java中的注释规范_IT/计算机_专业资料。java中的注释规范JAVA 注释方法及格式 1、单行(single-line)--短注释://…… 单独行注释:在代码中单起一行注释, 注释...
javadoc注释规范_专业资料。javadoc注释规范javadoc 做注释 一. Java 文档 // 注释一行 注释若干行 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法...
注释模板规范_java_计算机软件及应用_IT/计算机_专业资料。关于java注释模板规范设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后...
热门文档