1、源文件注释
源文件注释采用 /** …… */,在每个源文件的头部要有必要的注释信息,包括:文件名;文件编号;版本号;作者;创建时间;文件描述包括本文件历史修改记录等。中文注释模版:
/**
* 文 件 名 :
* CopyRright (c) 2008-xxxx:
* 文件编号:
* 创 建 人:
* 日 期:
* 修 改 人:
* 日 期:
* 描 述:
* 版 本 号:
*/
2、类(模块)注释:
类(模块)注释采用 /** …… */,在每个类(模块)的头部要有必要的注释信息,包括:工程名;类(模块)编号;命名空间;类可以运行的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:
如果模块输入输出参数或功能结构有较大修改,则每次修改必须添加以下
注释:
//Log ID:<Log编号,从1开始一次增加>
//Depiction:<对此修改的描述>
//Writer:修改者中文名
//Rewrite Date:<模块修改日期,格式:YYYY-MM-DD>
3、接口注释:
接口注释采用 /** …… */,在满足类注释的基础之上,接口注释应该包含描述接口的目的、它应如何被使用以及如何不被使用,块标记部分必须注明作者和版本。在接口注释清楚的前提下对应的实现类可以不加注释。
4、构造函数注释:
构造函数注释采用 /** …… */,描述部分注明构造函数的作用,不一定有块标记部分。
注释模版一:
/**
* 默认构造函数
*/
注释模版二:
/**
* Description : 带参数构造函数,
* 初始化模式名,名称和数据源类型
* @param schema: 模式名
* @param name: 名称
* @param type: 数据源类型
*/
5、函数注释:
函数注释采用 /** ……*/,在每个函数或者过程的前面要有必要的注释信息,包括:函数或过程名称;功能描述;输入、输出及返回值说明;调用关系及被调用关系说明等。函数注释里面可以不出现版本号(@version)。
注释模版一:
/**
* 函 数 名 :
* 功能描述:
* 输入参数: <按照参数定义顺序>
* <@param后面空格后跟着参数的变量名字
* (不是类型),空格后跟着对该参数的描述。>
*
* 返 回 值: - 类型 <说明>
* <返回为空(void)的构造函数或者函数,
* @return可以省略; 如果返回值就是输入参数,必须 * 用与输入参数的@param相同的描述信息; 必要的时* 候注明特殊条件写的返回值。>
* 异 常:<按照异常名字的字母顺序>
* 创 建 人:
* 日 期:
* 修 改 人:
* 日 期:
*/
注释模版二:
/**
* FunName: getFirstSpell
* Description : 获取汉字拼音首字母的字符串,
* 被生成百家姓函数调用
* @param: str the String是包含汉字的字符串
* @return String:汉字返回拼音首字母字符串;
* 英文字母返回对应的大写字母;
* 其他非简体汉字返回 '0';
* @Author: ghc
* @Create Date: 2008-07-02
*/
6、方法注释:
方法注释采用 /** …… */,对于设置 (Set 方法 ) 与获取 (Get 方法 ) 成员的方法,在成员变量已有说明的情况下,可以不加注释;普通成员方法要求说明完成什么功能,参数含义是什么且返回值什么;另外方法的创建时间必须注释清楚,为将来的维护和阅读提供宝贵线索。
7、方法内部注释:
控制结构,代码做了些什么以及为什么这样做,处理顺序等,特别是复杂的逻辑处理部分,要尽可能的给出详细的注释。
8、 全局变量注释:
要有较详细的注释,包括对其功能、取值范围、哪些函数或者过程存取以及存取时注意事项等的说明。
9、局部(中间)变量注释:
主要变量必须有注释,无特别意义的情况下可以不加注释。
10、实参/参数注释:
参数含义、及其它任何约束或前提条件。
11、字段/属性注释: 字段描述,属性说明。
12、常量:常量通常具有一定的实际意义,要定义相应说明。
分享到:
相关推荐
1.5 JAVA注释具体实现 . . . . . . . . . . . . . . . . . . . . . . . . . .13 1.6 Java 6中的性能优化 . . . . . . . . . . . . . . . . . . . . . . . . .18 1.7 java 参数的应用 -verbose . . . . . . . . . . ....
本文实例讲述了Python删除Java源文件中全部注释的实现方法。分享给大家供大家参考,具体如下: 同事想删除一个Java项目中的全部注释,让我帮忙想想办法。 没找不到合适工具,就写了这个脚本,遍历指定目录,查找*....
Java平台下的四种进程调度算法的模拟实现,代码精简,内有详细注释,看不懂随时call我。原来的代码有些问题,这个已改正,原来删不掉,没办法,再发了一个,原来下载过的可以直接问我要。
实现用Java编写实现记事本的全部功能,具体如下: (1)可实现文件的新建,打开,保存,另存和退出程序 (2)可实现对文字剪切,粘贴,复制,撤销,删除,全选,查找,替换等文字编辑; (3)可实现打开帮助中的版本...
【实例简介】图书管理系统 Java MySQL 完整实训代码,MVC三层架构组织,包含所有用到的...项目文档包括8000字的实训报告,从系统需求分析,系统设计,系统实现思路,系统具体实现都做了详细的分析,欢迎大家批评指正。
Java实现MD5大文件校验码详细解析: 包括具体方法解释、注释 通俗易懂、易于理解
java代码实现".xls和.xlsx"文件的导入和导出,有具体的题目描述和代码实现,注释也很详细!!!
程序界面友好,代码的可维护性好,包括必要的注释和相应的文档。 具体要求:基本的文本录入,字符修改,删除,换行,粘贴,复制,剪切等功能,主要包括: 1. 菜单栏设计及功能实现:菜单栏主要包括文件、编辑、格式...
用java写的操作系统的磁盘管理程序,有详细的源代码和代码注释,如有错漏,欢迎指正…………
附带的源代码部分,则是对毕业论文中设计理念的具体实现。代码结构清晰,注释详尽,便于学习者阅读和理解。通过这份源代码,学习者可以深入了解Spring Boot框架的使用技巧,掌握Java Web开发的基本流程和方法,提升...
Java 权限管理系统 shiro + ssm实现。 权限管理系统 shiro + ssm实现,实现菜单,有学习的可以下载哦!项目基于jdk1.8整合了springboot+mvc+mybatis(通用mapper)+druid+jsp+bootstrap等技术,springboot+Listener(监听器...
读者评论 前言 简介 第1章 对象导论 1.1 抽象过程 1.2 每个对象都有一个接口 1.3 每个对象都提供服务 1.4 被隐藏的具体实现 1.5 复用具体实现 1.6 继承 1.6.1 “是一个”(is-a)与“像是一个”(is-like-a)关系 ...
springboot+Listener(监听器),Filter(过滤器),Interceptor(拦截器),Servlet,springmvc静态资源,文件上传下载,多数据源切换,缓存,quartz定时任务(没有具体业务实现)等技术点都在项目中实现了,可谓是麻雀虽小五脏俱全!...
这个Java爬虫实战项目源码包含了爬虫框架的基本设计与实现,以及具体爬取网站的实现方法。代码中提供了详细的注释和解释,对于初学者也非常友好。通过这个源码,你可以深入了解Java爬虫的基础知识,学习如何使用Java...
该系统采用先进的JAVA技术,实现了高效、稳定的网络通信功能,可广泛应用于各种网络应用场景。 **论文部分**:详细介绍了系统的需求分析、设计思路、实现细节和测试结果。通过深入的理论分析和实践验证,探讨了JAVA...
具体任务有: (1)组织源程序的输入 (2)识别单词的类别并记录类别编号和值,形成二元式输出,得到单词流文件 (3)删除注释、空格和无用符号 (4)发现并定位词法错误,需要输出错误的位置在源程序中的第几行...
**Java毕业设计-Java论坛管理系统设计与实现(源码+论文)** 本资源提供了一个基于Java的论坛管理系统的完整设计与实现方案。该系统采用主流的Java技术栈,包括Spring Boot、MyBatis、MySQL等,实现了用户注册、...
另一种是功能执行语句,用于实现具体的功能,以分号(;)结束。 语句块:一对大括号{}包含的一系列语句称为语句块(代码块),语句块可以嵌套,即语句块内可以嵌套子语句块。 空格:在Java程序中,为了增加程序的...