java中代码注释规范,java代码怎么注释

java程序员有哪些应该注意的编码规范?

Java编码规范:　尽量使用完整的英文描述符采用适用于相关领域的术语采用大小写混合使名字可读尽量少用缩写，但如果用了，必须符合整个工程中的统一定义避免使用长的名字（小于15个字母为正常选择）避免使用类似的名字，或者仅仅是大小写不同的名字避免使用下划线（除静态常量等）标识符类型说明包（Package）的命名Package的名字应该采用完整的英文描述符，都是由一个小写单词组成。并且包名的前缀总是一个顶级域名

成都创新互联公司主营含山网站建设的网络公司,主营网站建设方案,成都App定制开发,含山h5成都微信小程序搭建,含山网站营销推广欢迎含山等地区企业咨询

，通常是com、edu、gov、mil、net、org等；如：com.yjhmily.test类（Class）的命名类名应该是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量保证类名简洁而富于描述。

为什么要为程序添加注释，在java程序中如何为程序添加注释？

定义规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性）。

// 注释一行

/* ...... */ 注释若干行

/** ...... */ 注释若干行，并写入 javadoc 文档

如下代码：

package com.qiu.lin.he;

/**

* 第三种注释方式

* @author Administrator

public class CeShi {

public static void main(String[] args) {

int str = 107653;

//System.out.print(str / (24 * 60 * 60) + "天");

/*System.out.print(str % (24 * 60 * 60) / (60 * 60) + "小时");

System.out.print(str % (24 * 60 * 60) % (60 * 60) / 60 + "分钟");*/

System.out.print(str % (24 * 60 * 60) % (60 * 60) % 60 + "秒");

}

编程中的注释分为三类单行注释，多行注释，文档注释；

晕~~~ 自己还是找到了 ·· 留给后来人吧···

java文档注释（有示例）

Java代码规范--注释

@author LEI

@version 1.10 2005-09-01

1 注释文档的格式注释文档将用来生成HTML格式的代码报告，所以注释文档必须书写在类、域、构造函数、方法、定义之前。注释文档由两部分组成——描述、块标记。

例如：

/**

* 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);

}

前两行为描述，描述完毕后，由@符号起头为块标记注视。

2 注释的种类2.1 文件头注释

文件头注释以 /*开始，以*/结束，需要注明该文件创建时间，文件名，命名空间信息。

例如：

* Created on 2005-7-2

* /

2.2 类、接口注释

类、接口的注释采用 /** … */，描述部分用来书写该类的作用或者相关信息，块标记部分必须注明作者和版本。

例如：

/**Title: XXXX DRIVER 3.0

*Description: XXXX DRIVER 3.0

*Company:XXXX有限公司

* @author Java Development Group

* @version 3.0

例如：

/**

* A class representing a window on the screen.

* For example:

* Window win = new Window(parent);

* win.show();

* @author Sami Shaio

* @version %I%, %G%

* @see java.awt.BaseWindow

* @see java.awt.Button

class Window extends BaseWindow {

...

}

2.3 构造函数注释

构造函数注释采用 /** … */，描述部分注明构造函数的作用，不一定有块标记部分。

例如：

/**

* 默认构造函数

有例如：

/**

* 带参数构造函数,初始化模式名,名称和数据源类型

* @param schema

* Ref 模式名

* @param name

* Ref 名称

* @param type

* byVal 数据源类型

2.4 域注释

域注释可以出现在注释文档里面，也可以不出现在注释文档里面。用/** … */的域注释将会被认为是注释文档热出现在最终生成的HTML报告里面，而使用/* … */的注释会被忽略。

例如：

/* 由于triger和表用一个DMSource，所以要区分和表的迁移成功标记 */

boolean isTrigerSuccess = false;

又例如：

/** 由于triger和表用一个DMSource，所以要区分和表的迁移成功标记 */

boolean isTrigerSuccess = false;

再例如：

/**

* The X-coordinate of the component.

* @see #getLocation()

int x = 1263732;

2.5 方法注释

方法注释采用 /** … */，描述部分注明方法的功能，块标记部分注明方法的参数，返回值，异常等信息。例如：

/**

* 设置是否有外码约束

* @param conn

* Connection 与数据库的连接

2.6 定义注释

规则同域注释。

3 注释块标记3.1 标记的顺序

块标记将采用如下顺序：

…

* @param (classes, interfaces, methods and constructors only)

* @return (methods only)

* @exception (@throws is a synonym added in Javadoc 1.2)

* @author (classes and interfaces only, required)

* @version (classes and interfaces only, required. See footnote 1)

* @see

* @since

* @serial (or @serialField or @serialData)

* @deprecated (see How and When To Deprecate APIs)

* …

一个块标记可以根据需要重复出现多次，多次出现的标记按照如下顺序：

@author 按照时间先后顺序（chronological）

@param 按照参数定义顺序（declaration）

@throws 按照异常名字的字母顺序（alphabetically）

@see 按照如下顺序：

@see #field

@see #Constructor(Type, Type...)

@see #Constructor(Type id, Type id...)

@see #method(Type, Type,...)

@see #method(Type id, Type, id...)

@see Class

@see Class#field

@see Class#Constructor(Type, Type...)

@see Class#Constructor(Type id, Type id)

@see Class#method(Type, Type,...)

@see Class#method(Type id, Type id,...)

@see package.Class

@see package.Class#field

@see package.Class#Constructor(Type, Type...)

@see package.Class#Constructor(Type id, Type id)

@see package.Class#method(Type, Type,...)

@see package.Class#method(Type id, Type, id)

@see package

3.2 标记介绍

3.2.1 @param标记

@param后面空格后跟着参数的变量名字（不是类型），空格后跟着对该参数的描述。

在描述中第一个名字为该变量的数据类型，表示数据类型的名次前面可以有一个冠词如：a,an,the。如果是int类型的参数则不需要注明数据类型。例如：

…

* @param ch the char 用用来……

* @param _image the image 用来……

* @param _num 一个数字……

…

对于参数的描述如果只是一短语，最好不要首字母大写，结尾也不要句号。

对于参数的描述是一个句子，最好不要首字母大写，如果出现了句号这说明你的描述不止一句话。如果非要首字母大写的话，必须用句号来结束句子。（英文的句号）

公司内部添加ByRef和ByVal两个标记，例如：

* @param _image the image ByRef 用来……

说明该参数是引用传递（指针），ByVal可以省略，表示是值传递。

3.2.2 @return标记

返回为空（void）的构造函数或者函数，@return可以省略。

如果返回值就是输入参数，必须用与输入参数的@param相同的描述信息。

必要的时候注明特殊条件写的返回值。

3.2.3 @throws 标记

@throws以前使用的是@exception。

@throws的内容必须在函数的throws部分定义。

3.2.4 @author标记

类注释标记。

函数注释里面可以不出现@author。

3.2.5 @version

类注释标记。

文章出处：

java 注释规范

/**

* 方法功能描述

* @param 参数说明

* @author 作者

* @return 返回格式

* @exception 异常

java工作中良好的代码注释习惯是什么

注释是为了方便自己或代码维护方更容易地读懂代码的用处。

一、背景

1、当我们第一次接触某段代码，但又被要求在极短的时间内有效地分析这段代码，我们需要什么样的注释信息？

2、怎么样避免我们的注释冗长而且凌乱不堪呢？

3、在多人协同开发、维护的今天，我们需要怎么样的注释来保证高质、高交的进行开发和维护工作呢？

二、意义

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

三、注释的原则

1、注释形式统一

在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其他项目组发现他们的注释规范与这份文档不同，按照他们的规范写代码，不要试图在既成的规范系统中引入新的规范。

2、注释的简洁

内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。

3、注释的一致性

在写代码之前或者边写代码边写注释，因为以后很可能没有时间来这样做。另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。通常描述性注释先于代码创建，解释性注释在开发过程中创建，提示性注释在代码完成之后创建。修改代码的同时修改相应的注释，以保证代码与注释的同步。

4、注释的位置

保证注释与其描述的代码相邻，即注释的就近原则。对代码的注释应放在其上方相邻或右方的位置，不可放在下方。避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释要对齐。

5、注释的数量

注释必不可少，但也不应过多，在实际的代码规范中，要求注释占程序代码的比例达到20%左右。注释是对代码的“提示”，而不是文档，程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱，注释的花样要少。不要被动的为写注释而写注释。

6、删除无用注释

在代码交付或部署发布之前，必须删掉临时的或无关的注释，以避免在日后的维护工作中产生混乱。

7、复杂的注释

如果需要用注释来解释复杂的代码，请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码，而应该重写它。尽管一般不应该为了使代码更简单便于使用而牺牲性能，但必须保持性能和可维护性之间的平衡。

8、多余的注释

描述程序功能和程序各组成部分相互关系的高级注释是最有用的，而逐行解释程序如何工作的低级注释则不利于读、写和修改，是不必要的，也是难以维护的。避免每行代码都使用注释。如果代码本来就是清楚、一目了然的则不加注释，避免多余的或不适当的注释出现。

9、必加的注释

典型算法必须有注释。在代码不明晰或不可移植处必须有注释。在代码修改处加上修改标识的注释。在循环和逻辑分支组成的代码中添加注释。为了防止问题反复出现，对错误修复和解决方法的代码使用注释，尤其是在团队环境中。

10、注释在编译代码时会被忽略，不编译到最后的可执行文件中，所以注释不

会增加可执行文件的大小。

四、JAVA注释技巧

1、空行和空白字符也是一种特殊注释。利用缩进和空行，使代码与注释容易区

别，并协调美观。

2、当代码比较长，特别是有多重嵌套时，为了使层次清晰，应当在一些段落的

结束处加注释（在闭合的右花括号后注释该闭合所对应的起点），注释不能

写得很长，只要能表示是哪个控制语句控制范围的结束即可，这样便于阅读。

3、将注释与注释分隔符用一个空格分开，在没有颜色提示的情况下查看注释时，

这样做会使注释很明显且容易被找到。

4、不允许给块注释的周围加上外框。这样看起来可能很漂亮，但是难于维护。

5、每行注释（连同代码）不要超过120个字(1024×768)，最好不要超过80

字(800×600) 。

6、Java编辑器（IDE）注释快捷方式。Ctrl+/ 注释当前行,再按则取消注释。

7、对于多行代码的注释，尽量不采用“/*......*/”，而采用多行“//”注释，

这样虽然麻烦，但是在做屏蔽调试时不用查找配对的“/*......*/”。

8、注释作为代码切换开关，用于临时测试屏蔽某些代码。

当前名称：java中代码注释规范,java代码怎么注释
文章出自：http://myzitong.com/article/dsehiip.html