JAVA文件头注释格式

合集下载

javadoc的注释

javadoc的注释
Javadoc是一种用于Java源代码的注释格式，它可以被特定的工具提取并转换成一份可供开发者参考的文档。

Javadoc注释以`/`开头，以`/`结尾，通常位于类、方法或字段的前面。

它们允许开发者描述代码的功能、参数、返回值以及可能的异常情况。

Javadoc 注释通常包括以下几个部分：
1. 描述部分，对于类、方法或字段的描述，通常包括其作用、使用方法等信息。

2. 参数部分，如果是方法的注释，通常会包括对方法参数的描述，包括参数名、参数类型以及参数的作用。

3. 返回部分，对于方法的注释，会描述该方法的返回值类型以及可能的返回值情况。

4. 异常部分，对于方法的注释，会描述该方法可能会抛出的异常类型及异常情况。

Javadoc注释的好处在于它们可以被Javadoc工具解析并生成
代码文档，这样其他开发者就可以通过阅读文档了解代码的功能和
使用方法。

此外，Javadoc注释也可以提高代码的可读性，让其他
开发者更容易理解代码的含义和设计初衷。

除了以上提到的基本部分，Javadoc注释还可以包括一些其他
的标签，比如`@author`用于指定作者、`@version`用于指定版本号、`@see`用于指定相关的链接等。

这些标签可以进一步丰富Javadoc
注释的内容，使得生成的文档更加完整和详尽。

总之，Javadoc注释是Java语言中一种非常有用的注释格式，
它可以帮助开发者更好地理解和使用代码，同时也为代码文档的生
成提供了便利。

因此，在编写Java代码时，合理、规范地使用Javadoc注释是非常重要的。

java三种注释

java三种注释
java三种注释
1.java规定了三种注释⽅式：单⾏注释、多⾏注释、⽂档注释
2.单⾏注释和多⾏注释的作⽤：
对所写的程序进⾏解释和说明，增强可读性
调试所写的代码：例如对部分代码注释，进⾏运⾏来找到代码错误的地⽅
特点：单⾏注释和多⾏注释，注释的内容不参与编译
单⾏注释
格式：
class helloJava{
//单⾏注释：如下的main⽅法是程序的⼊⼝！
public static void main(String args[]){
//单⾏注释：如下的语句表⽰输出到控制台
System.out.println("Hello World!");
}
}
多⾏注释
格式：
/*
这⾥是多⾏注释
*/
⽂档注释（java特有）
格式：
/**
@author 指定java程序的作者
@version 指定源⽂件的版本
*/
注释内容可以被JDK提供的⼯具Javadoc所解析，⽣成⼀套以⽹页⽂件形式体现的该程序的说明⽂档命令： javadoc -d Myjavadoc -author -version 1.2注释.java
解释：命令⾏格式为Javadoc -d ⽂件夹名字 -author -version ⽂件名.Java
⽂件夹是⾃⼰随便起的，会被放在与Java⽂件相同的⽂件⽬录下。

注意：多⾏注释不能够嵌套使⽤。

java文档注释规范（一）

java⽂档注释规范（⼀）https:///huangsiqian/article/details/82725214Javadoc⼯具将从四种不同类型的“源”⽂件⽣成输出⽂档：Java语⾔类的源⽂件（.java），包注释⽂件，概述注释⽂件和其他未处理的⽂件。

包注释⽂件（Package Comment File）每个包都有⾃⼰的⽂档注释。

有两种⽅式来创建包注释⽂件：package-info.java - 可以包含包的声明，包注解（anotation），包注释和Javadoc 标签（tag）。

包注释放在包声明之前。

这是JDK 5.0新引⼊的特性。

如下。

File: java/applet/package-info.java 注意：⽂档注释块内部⾏⾸的*号是可选的/*** Provides the classes necessary to create an applet and the classes an applet uses* to communicate with its applet context.* * The applet framework involves two entities:* the applet and the applet context. An applet is an embeddable window (see the* {@link java.awt.Panel} class) with a few extra methods that the applet context* can use to initialize, start, and stop the applet.** @since 1.0* @see java.awt*/package ng.applet;package.html - 只能包含包注释和Javadoc标签，不能包含包注解。

java有效的注释说明

java有效的注释说明Java是一种广泛使用的编程语言。

为了保证代码的清晰易懂以及方便后期维护，我们要给Java程序添加注释。

本文将从以下几个方面介绍Java有效的注释说明。

一、注释的种类Java程序中最常见的注释有三种：单行注释、多行注释、文档注释。

单行注释以"//"开头，多行注释以"/*"开头和"*/"结尾，文档注释以"/**"开头和"*/"结尾。

其中，文档注释最为重要，也最为常用。

二、文档注释的使用文档注释是Java程序中的重要注释，也是Java代码中最常用的注释之一。

文档注释可以让我们用简洁清晰的语言来描述代码的作用、参数、返回值等信息。

其具体写法如下：/*** 方法的作用* @param 参数名参数说明* @return 返回值说明*/其中，p标签可以用来描述方法的作用，param标签用来描述参数的名称和说明，return标签用于描述方法的返回值。

三、注释的规范在Java中，注释也是需要遵循一定的规范的。

首先，注释应该写在被注释项的前面或者后面，不需要对齐代码。

其次，注释应该简洁明了，避免出现过于冗长的注释。

最后，避免在注释中出现包含比代码本身还复杂的格式和语法。

四、注释的使用场景注释的使用场景包括以下几个方面：首先，注释可以用来描述程序中的重要变量、方法、类的作用和功能。

其次，注释可以在调试程序时帮助快速定位问题所在。

最后，注释还可以在代码交接、阅读和修改时提供较为清晰的方向和思路。

综上所述，Java有效的注释是保证代码清晰易懂、方便维护的重要方面之一。

Java程序员应该养成良好的注释习惯，在代码编写上也应该注重注释的规范性、简洁性和对实际需求的协调性。

IDEA中如何设置文件头注释和方法注释(详解)

IDEA中如何设置文件头注释和方法注释（详解）在IntelliJ IDEA中，可以通过一些设置来自定义文件头注释和方法注释，使代码更加规范和易读。

下面我将详细介绍如何设置文件头注释和方法注释。

首先，我们需要打开IDEA的设置窗口。

可以通过点击菜单栏的“File”->“Settings”或直接按下快捷键“Ctrl + Alt + S”打开设置窗口。

一、文件头注释的设置：1. 打开设置窗口后，选择“Editor”->“File and Code Templates”选项。

3. 在右侧的文件列表中选择“File Header”文件。

这是文件头注释所使用的模板。

4. 在“Template text”输入框中，可以设置文件头注释的内容。

在输入框中，可以使用一些预定义变量来动态地生成注释，例如：-${DATE}：当前日期-${TIME}：当前时间-${USER}：当前使用IDEA的用户名-${YEAR}：当前年份-${ORGANIZATION}：项目组织名称-${PACKAGE_NAME}：当前文件的包名等例如，一个常见的Java文件头注释模板可以设置为：```/***/```5.当设置完注释模板后，点击“OK”按钮保存设置。

二、方法注释的设置：1. 在设置窗口中，选择“Editor”->“File and Code Templates”选项。

3. 在右侧的文件列表中选择“Java Method”文件。

这是方法注释所使用的模板。

4. 在“Template text”输入框中，可以设置方法注释的内容。

同样可以使用一些预定义变量来动态生成注释。

例如，一个常见的Java方法注释模板可以设置为：```/***/```5.当设置完注释模板后，点击“OK”按钮保存设置。

以上就是设置文件头注释和方法注释的详细步骤。

在实际的开发中，根据团队的规范和项目的需要，可以根据上述步骤进行定制化的设置。

这样的设置能够提高代码的可读性和可维护性，也便于团队成员之间的协作。

Java语言编程规范（华为公司）

Java语言编程规范（华为公司）DKBA华为技术有限公司企业技术规范DKBAXXXX-2001.12代替（DKBA200106-003）Java语言编程规范2001-12-XX发布2001-12-XX实施华为技术有限公司发布VVVVVVV VVVVVVVVVVVX。

XVX.X VX.X VX.X VX.XVX.X 目次前言 .............................................................................. .. (3)1 范围112 规范性引用文件113 术语和定义114 排版规范124.1 规则121.*程序块要采用缩进风格编写，缩进12的空格数为4个。

122.*分界符（如大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。

在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。

133.*较长的语句、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。

134.*不允许把多个短语句写在一行中，即一行只写一条语句5.*if, for, do, while, case,13switch, default 等语句自占一行，且if, for, do, while等语句的执行语句无论多少都要加括号{}。

6.*相对独立的程序块之间、变量说明13之后必须加空行。

7.*对齐只使用空格键，不使用TAB键。

14VVVVVVV VVVVVVVVVVVX。

XVX.X VX.X VX.X VX.XVX.X 8.*在两个以上的关键字、变量、常量14进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加空格。

java编码规范

1范围2规范性引用文件3定义和缩略语4文件组织4.1 文件结构规则4-1-1：包名只允许使用小写字母，包命名格式如下：“倒置的公司域.产品名.模块名”，模块名可以根据产品结构划分为多级模块。

如：package com.h3c.xlog.nta.dao;规则4-1-2：Java源代码文件使用‘src’作为一级目录，按照包名成树状目录结构存放。

如：…\src\com\h3c\xlog\nta\dao\Sample.java规则4-1-3：Java源代码文件名与类名相同4.2 文件格式标准Java源代码文件头格式如下/*** Copyright (c) 2007,Hangzhou H3C Technologies Co.,Ltd.All rights reserved.* </* ...........................................................................* Product :iMC V300R002* Module Name;* Date Created:YYYY-MM-DD* Creator:* Description;** ...........................................................................* Modification History* DATE NAME DESCRIPTION* ..........................................................................* YYYY-MM-DD John XXXX project,new code file.** .........................................................................*/规则4-2-1：任何一个代码源文件必须包含有标准的文件头，且其中的文件名、产品、日期、作者等内容填写完整。

idea创建JAVAClass时自动生成头部文档注释的方法

idea创建JAVAClass时⾃动⽣成头部⽂档注释的⽅法IDEA设置⽂档注释模板
创建Class⽂件时⾃动⽣成的头部注释如图
如何配置idea的头部注释格式，可以⽣成像之前的注释格式⼀样的⽂档注释？
File->settings->Editor->File and Code Templates->Files->Class
原先模板
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
public class ${NAME} {
}
修改后模板
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
/**
\* Created with IntelliJ IDEA.
\* @author: xiyue
\* Date: ${DATE}
\* Time: ${TIME}
\* To change this template use File | Settings | File Templates.
\* Description:
\*/
public class ${NAME} {
}
到此这篇关于idea创建JAVA Class时⾃动⽣成头部⽂档注释的⽅法的⽂章就介绍到这了,更多相关idea⽣成头部⽂档注释内容请搜索以前的⽂章或继续浏览下⾯的相关⽂章希望⼤家以后多多⽀持！。

1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。

/** * ${tags} * ${see_to_target} */
（8）getter 方法标签：
/**
* @Title:
${enclosing_method} 
* @Description: please write your description 
* @return:
${field_type} 
*/
（9）setter 方法标签：
/** * @Title: ${enclosing_method} * @Description: please write your description * @return: ${field_type} */
ren
Eclipse 注释规范模版总结
1、具体操作
（1）在 eclipse 中，打开 Window->Preference->Java->Code Style->Code Template
（2）然后展开 Comments 节点就是所有需设置注释的元素，参照 2 注释规范对应设置即可
2、注释规范
（1）文件(Files)注释标签
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param:
${tags}
* @return:
${return_type}
* @throws
* @author
${user}
* @Date
${date} ${time}
*/
输入设置模板：
/** * ${file_name} Create on ${date} * * Copyright (c) ${date} by taotaosoft * * @author <a href="xiuzhong.li@">Jerryli</a> * @version 1.0 * */
* @author: 名字
* @version V1.0
* Createdate:
${date} ${time}
*
* Modification History:
* Date
Author
Version
Discription
*
* ${date}
wu.zh
1.0
1.0
* Why & What is modified: <修改原因描述>
* @param: ${tags}
* @throws
*/
（5）方法(Methods)标签：
/** * @Title: ${enclosing_method} * @Description: ${todo}(这里用一句话描述这个方法的作用) * @param: ${tags} * @return: ${return_type} * @throws */
/**
* FileName:
${file_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* All rights Reserved, Designed By ZTE-ITS
* Copyright: Copyright(C) 2010-2011
* Company
ZTE-ITS WuXi LTD.
*/
（3）字段(Fields)注释标签：
/** * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) */
（4）构造函数标签：
/**
* @Title:
${enclosing_type}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @ClassName:
${file_name}
* @Description: ${todo}(用一句话描述该文件做什么)
*
* @author
${user}
* @version
V1.0
* @Date
${date} ${time}
*/
方法
/**
* @Title:
${enclosing_method}
（6）覆盖方法(Overriding Methods)标签:
/** * Title: ${enclosing_method} * Description: * ${tags} * ${see_to_overridden} */
（7）代表方法(Delegate Methods)标签：
myeclipse 中 java 文件头注释格式设置
2011-10-08 13:11:33| 分类： IDE|举报|字号订阅
windows->preferences->java->Code Templates->comments->Type->edit
Eclipse 注释规范模版总结
新建类文件
/**
注意选择自动添加注释
养成一个规dows-->preference Java-->Code Style-->Code Templates code-->new Java files
选中点编辑
${filecomment} ${package_declaration} /** * @author 作者姓名 E-mail: email 地址 * @version 创建时间：${date} ${time} * 类说明 */ ${typecomment} ${type_declaration}
*/
（2）类型(Types)注释标签（类的注释）：
/** * @ClassName:
${type_name}
* @Description:${todo}(这里用一句话描述这个类的作用)
* @author: Android_Robot
* @date:
${date} ${time}
*
* ${tags}