一、背景及意义
略
二、用途
1、用于文档生成器工具自动生成最终生成代码文档。
2、鼓励写清晰的代码,代码就是文档,注释就是需求。
三、注释的原则
1、必须的注释
(1)典型算法必须有注释。
(2)在代码不明晰或不可移植处必须有注释。
(3)在代码修改处加上修改标识的注释,以保证代码与注释的同步。
(4)在循环和逻辑分支组成的代码中添加注释。
(5)为了防止问题反复出现,对错误修复和解决方法的代码使用注释,尤其是在团队环境中。
2、 注释形式简洁和一致
内容要简单、明了、含义准确,防止注释的多义性。一致的标点和结构的样式。
3、 注释的顺序
(1)在写代码之前或者边写代码边写注释。
(2)描述性
注释先于代码创建。
(3)解释性
注释在开发过程中创建。
(4)提示性注释
在代码完成之后创建。
4、 注释的位置
注释的就近原则。对代码的注释应放在其上方相邻或右方的位置。在批注变量声明时,所有行尾注释要对齐。
5、 注释的数量
注释必不可少,但也不应过多,在实际的代码规范中,要求注释占程序代码的比例达到20%左右。注释是对代码的“提示”。
避免每行代码都使用注释。对于复杂的注释,请检查此代码以确定是否应该重写。
6、删除无用注释
在代码交付或部署发布之前,必须删掉临时的或无关的注释,以避免在日后的维护工作中产生混乱。
四、JAVA注释技巧
1、空行和空白字符也是一种特殊注释。利用缩进和空行,使代码与注释容易区别,并协调美观。
2、当代码比较长,特别是有多重嵌套时,为了使层次清晰,应当在一些段落的结束处加注释(在闭合的右花括号后注释该闭合所对应的起点),注释不能写得很长,只要能表示是哪个控制语句控制范围的结束即可,这样便于阅读。
3、将注释与注释分隔符用一个空格分开,在没有颜色提示的情况下查看注释时,这样做会使注释很明显且容易被找到。
4、不允许给块注释的周围加上外框。这样看起来可能很漂亮,但是难于维护。
5、每行注释(连同代码)不要超过120个字(1024×768),最好不要超过80字(800×600) 。
6、Java编辑器(IDE)注释快捷方式。Ctrl+/ 注释当前行,再按则取消注释。
7、对于多行代码的注释,尽量不采用“/*......*/”,而采用多行“//”注释,这样虽然麻烦,但是在做屏蔽调试时不用查找配对的“/*......*/”。
8、注释作为代码切换开关,用于临时测试屏蔽某些代码。
例一:
//*/
codeSegement1;
//*/
改动第一行就成了:
/*/
codeSegement1;
//*/
例二:
//----------------------第一段有效,第二段被注释
//*/
codeSegement1;
/*/
codeSegement2;
//*/
只需删除第一行的/就可以变成:
//----------------------第一段被注释,第二段有效
/*/
codeSegement1;
/*/
codeSegement2;
//*/
五、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注释具体实现
1、源文件注释
源文件注释采用 /** …… */,在每个源文件的头部要有必要的注释信息,包括:文件名;文件编号;版本号;作者;创建时间;文件描述包括本文件历史修改记录等。中文注释模版:
/**
* 文 件 名 :
* CopyRright (c) 2008-xxxx:
* 文件编号:
* 创 建 人:
* 日 期:
* 修 改 人:
* 日 期:
* 描 述:
* 版 本 号:
*/
2、类(模块)注释:
类(模块)注释采用 /** ……
*/,在每个类(模块)的头部要有必要的注释信息,包括:工程名;类(模块)编号;命名空间;类可以运行的JDK版本;版本号;作者;创建时间;类(模
块)功能描述(如功能、主要算法、内部各部分之间的关系、该类与其类的关系等,必要时还要有一些如特别的软硬件要求等说明);主要函数或过程清单及本类
(模块)历史修改记录等。
英文注释模版:
/**
* CopyRright (c)2008-xxxx: <Sun Inc>
* 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>
2、接口注释:
接口注释采用 /** …… */,在满足类注释的基础之上,接口注释应该包含描述接口的目的、它应如何被使用以及如何不被使用,块标记部分必须注明作者和版本。在接口注释清楚的前提下对应的实现类可以不加注释。
3、构造函数注释:
构造函数注释采用 /** …… */,描述部分注明构造函数的作用,不一定有块标记部分。
注释模版一:
/**
* 默认构造函数
*/
注释模版二:
/**
* Description : 带参数构造函数,
* 初始化模式名,名称和数据源类型
* @param schema: 模式名
* @param name: 名称
* @param type: 数据源类型
*/
4、函数注释:
函数注释采用 /** ……*/,在每个函数或者过程的前面要有必要的注释信息,包括:函数或过程名称;功能描述;输入、输出及返回值说明;调用关系及被调用关系说明等。函数注释里面可以不出现版本号(@version)。
注释模版一:
/**
* 函 数 名 :
* 功能描述:
* 输入参数: <按照参数定义顺序>
* <@param后面空格后跟着参数的变量名字
* (不是类型),空格后跟着对该参数的描述。>
*
* 返 回 值: - 类型 <说明>
* <返回为空(void)的构造函数或者函数,
* @return可以省略; 如果返回值就是输入参数,必须 * 用与输入参数的@param相同的描述信息; 必要的时* 候注明特殊条件写的返回值。>
* 异 常:<按照异常名字的字母顺序>
* 创 建 人:
* 日 期:
* 修 改 人:
* 日 期:
*/
注释模版二:
/**
* FunName: getFirstSpell
* Description : 获取汉字拼音首字母的字符串,
* 被生成百家姓函数调用
* @param: str the String是包含汉字的字符串
* @return String:汉字返回拼音首字母字符串;
* 英文字母返回对应的大写字母;
* 其他非简体汉字返回 '0';
* @Author: ghc
* @Create Date: 2008-07-02
*/
5、方法注释:
方法注释采用 /** …… */,对于设置 (Set 方法 ) 与获取 (Get 方法 )
成员的方法,在成员变量已有说明的情况下,可以不加注释;普通成员方法要求说明完成什么功能,参数含义是什么且返回值什么;另外方法的创建时间必须注释清
楚,为将来的维护和阅读提供宝贵线索。
6、方法内部注释:
控制结构,代码做了些什么以及为什么这样做,处理顺序等,特别是复杂的逻辑处理部分,要尽可能的给出详细的注释。
7、 全局变量注释:
要有较详细的注释,包括对其功能、取值范围、哪些函数或者过程存取以及存取时注意事项等的说明。
8、局部(中间)变量注释:
主要变量必须有注释,无特别意义的情况下可以不加注释。
9、实参/参数注释:
参数含义、及其它任何约束或前提条件。
10、字段/属性注释: 字段描述,属性说明。
11、常量:常量通常具有一定的实际意义,要定义相应说明。
分享到:
相关推荐
Arch-Linux-Install-ScriptArch_Linux_安装脚本_Arch-Linux-Installer
"cacti-plugin-arch-2.0.tar.gz" 是一个针对Cacti的插件包,用于扩展Cacti的功能,提供更丰富的监控选项。此插件名为“Arch”,可能是对系统架构或性能分析相关的增强。 该压缩包文件的名称表明它是版本2.0,通常这...
基于android8.1源码平台中生成的jar,亲测可用!!!!
变系数ARCH-M模型是时间序列分析领域的重要研究对象,其核心在于通过截面似然估计来检验模型是否具有条件异方差性(ARCH效应)。首先,我们来探讨一下条件异方差性的概念,它是指在时间序列分析中,随机变量的条件...
高级java笔试题 本文纯原创,搭建后的博客/文档网站可以参考: 。如需转载请说明原处。 文章内容目录 最后的效果请访问 : 第一部分 - 博客/文档系统的搭建 搭建博客有很多选择,平台性的比如: 知名的CSDN, 博客园, ...
标题中的"Python库 | arch-4.11-cp35-cp35m-win32.whl"指的是一个特定版本的Python库,名为“arch”,版本为4.11,适用于Python 3.5解释器(由"cp35"标识),且是针对32位Windows操作系统("win32")的。"cp35m"表示...
首先,我们需要解压“zulu-a-arch64-java-jdk1326.dmg.zip”,这会得到一个名为“zulu-a-arch64-java-jdk1326.dmg”的镜像文件。然后,使用Macbook的内置磁盘工具或者双击该镜像文件,将其装载到系统中。接着,打开...
python库。 资源全名:arch-4.8.0-cp27-cp27m-win32.whl
Next Generation On Demand (NGOD) Asset Architecture Comcast-SP-NGOD-ASSET-ARCH-I03-100731 Issued July 31, 2010
安装克隆这个仓库git clone https://github.com/jannispinter/arch-openwrt-buildroot.git构建 docker 镜像 cd arch-openwrt-buildrootdocker build -t= " arch-openwrt-buildroot:trunk " . 最后的点表示Dockerfile...
资源来自pypi官网。 资源全名:arch-4.17-cp39-cp39-manylinux1_x86_64.whl
Next Generation On Demand (NGOD) Overall Architecture Comcast-SP-NGOD-GEN-ARCH-I03-100731 Issued July 31, 2010
解压缩后的"arch-snds100"文件包含了一系列源代码文件和配置文件,这些文件通常分为几个部分: 1. **头文件(Header Files)**:定义了驱动程序使用的函数原型、结构体和常量,供其他模块引用和调用。 2. **C...
资源来自pypi官网。 资源全名:arch-4.9.1-cp36-cp36m-macosx_10_6_intel.whl
我的Arch_Linux安装步骤和日志_Arch-Linux-install-log
arch-model-estimation_solution.ipynb
Arch_Linux_盒装安装媒介的小盒子_arch-media-box-typst
**arch-box** 是一个专为Arch Linux自动化构建的项目,旨在为不同的虚拟化和容器环境提供预配置的Arch Linux镜像。它支持多种提供程序,包括 **Vagrant** 和 **VirtualBox**,同时也可能适用于 **QEMU** 等其他虚拟...
UPnP协议的设备架构版本2.0(UPnP-arch-DeviceArchitecture-v2.0)详细介绍了UPnP协议的开发流程,这其中包括寻址、发现、描述、控制、事件、展现等6个过程的具体实现。对于开发者而言,这是理解和应用UPnP协议的...