导航:首页 > 编程语言 > java注释设置
java注释设置
发布时间：2022-04-25 22:25:37❶ java文件怎么配置多行注释
您好，提问者：
可以在配置管理-->搜索：keys进行配置。
单行注释：Alt+/
多行注释：选中 Ctrl+Shift+/
❷ 如何在Java中使用注释
java中的注释与大多数编程语言是一样的
// 双斜杠，表示注释一行语句
/* */ 多行注释
当然，还有文档注释： /** */
❸ 如何为JAVA程序添加注释
有三种注释方法
单行注释：在代码后面 打出 //
多行注释 /* */
文档注释 /** */
❹ java中的注释可分为三种类型
Java中三种类型的注释：
单行注释：// 注释内容
多行注释：/*... 注释内容....*/
文本注释：/**.. 注释内容....*/
代码注释是架起程序设计者与程序阅读者之间的通信桥梁，最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以不是为写注释而写注释。
备注：简单的代码做简单注释，注释内容不大于10个字即可，另外，持久化对象或VO对象的getter、setter方法不需加注释。
(4)java注释设置扩展阅读：
类（模块）注释采用 /** …… */，在每个类（模块）的头部要有必要的注释信息，包括：工程名；类（模块）编号；命名空间；类可以运行的JDK版本；版本号；作者；创建时间；类（模块）功能描述（如功能、主要算法、内部各部分之间的关系、该类与其类的关系等，必要时还要有一些如特别的软硬件要求等说明）；主要函数或过程清单及本类（模块）历史修改记录等。
❺ java 中的几种注释方式
我看动力节点的java基础大全301集教中的三种注释方法：
1、单行注释 //注释的内容
2、多行注释/*......*/
3、/**......*/，这种方式和第二种方式相似。这种格式是为了便于javadoc程序自动生成文档。
下面介绍一下Javadoc的标记：
特别声明：
（1）javadoc针对public类生成注释文档
（2）javadoc只能在public、protected修饰的方法或者属性之上
（3）javadoc注释的格式化：前导*号和HTML标签
（4）javadoc注释要仅靠在类、属性、方法之前
下面主要举例说明第三种注释的应用：
（1）首先编写.java文件
（2）在命令行中执行以下dos命令：
javadoc *.java //根据相应的Java源代码及其说明语句生成HTML文档
//javadoc标记：是@开头的，对javadoc而言，特殊的标记。
（3）在当前目录下就会产生doc文件夹，里面有一系列的.html文件
附上代码：
[java]view plain
<spanstyle="font-size:18px;">*/
/**javadoc注释的内容
*/
publicclassHello{
/**属性上的注释*/
publicStringname;
/**这是main方法,是程序的入口
*@paramargs用户输入参数
*/
publicstaticvoidmain(String[]args){
System.out.println("HelloWorld!");
f1();
}
/**这是第1个方法,其作用是...*/
publicstaticvoidf1(){
System.out.println("f1()！");
}
}</span>
<spanstyle="font-size:18px;">importjava.io.IOException;
/**javadoc注释内容
*@since1.0
*@version1.1
*@authorBlueJey
*<br>链接到另一个文档{@linkHello},就这些
*seeHello
*/
publicclassHelloWorld{
/**非public，protected属性上的注释不生成*/
publicStringname;
/**这是main方法，是程序的入口
*@paramargs用户输入的参数，是数组
*@throwsIOExceptionmain方法io异常
*/
publicstaticvoidmain(Stringargs[])throwsIOException{
System.out.println("helloWorld!");
f1();
f2(1);
}
/**这是第一个方法，其作用是....
*@deprecated从版本1.2开始，不再建议使用此方法
*/
publicstaticvoidf1(){
System.out.println("fl()!");
}
/**这是第二个方法，其作用是....
*@return返回是否OK
*@parami输入参数i
*@seeHello
*@throwsIOExceptionio异常
*/
publicstaticStringf2(inti)throwsIOException{
System.out.println("f1()!");
return"OK";
}
}</span>
[java]view plain
注意：
如果源文件中有用到@version,@author标记，则在执行javadoc命令时，要加-version-author
javadoc-version-author-ddoc*.java
（其中用-version用于提取源文件中的版本信息-author用于提取源文件中的作者信息）
❻ java代码如何快速添加作者描述的注释最好能有详细的图解
Window -->Preferences->Java->Editor->Templates ，
在这里new一个自己的插入注释的快捷方式名称，具体设置如下：
Name处输入 remark (任意你喜欢的名称)
context处选 java 后边勾选Automatically insert复选框
Description 这里可以任意输入描述
Pattern :(自定义格式)
/**
* @author ${user}
* @date : ${date} ${time}
*/
到这里全部设置完毕，下面 OK,找个java类,找个空白处测试一下, 输入remark(前面写的那个Name名称),
再alt+/ 应该按一下就能看到刚才的Description的内容。
❼ java中如何自动生成注释
你说的应该是生成javadoc吧?
最简单方式就是使用命令行, cd到你的项目源代码目录下, 输入如下指令:
javadoc-ddocs-subpackagescom.yourpackage
其中-d docs指定了生成的javadoc在相对目录docs下, -subpackages com.yourpackage指定了你要被生成javadoc的源代码包.
JAVADOC是官方提供的一种生成注释文档的工具, 他的用法如下:
用法:javadoc[options][packagenames][sourcefiles][@files]
-overview<file>从HTML文件读取概览文档
-public仅显示public类和成员
-protected显示protected/public类和成员(默认值)
-package显示package/protected/public类和成员
-private显示所有类和成员
-help显示命令行选项并退出
-doclet<class>通过替代doclet生成输出
-docletpath<path>指定查找doclet类文件的位置
-sourcepath<pathlist>指定查找源文件的位置
-classpath<pathlist>指定查找用户类文件的位置
-cp<pathlist>指定查找用户类文件的位置
-exclude<pkglist>指定要排除的程序包列表
-subpackages<subpkglist>指定要递归加载的子程序包
-breakiterator计算带有BreakIterator的第一个语句
-bootclasspath<pathlist>覆盖由引导类加载器所加载的
类文件的位置
-source<release>提供与指定发行版的源兼容性
-extdirs<dirlist>覆盖所安装扩展的位置
-verbose输出有关Javadoc正在执行的操作的信息
-locale<name>要使用的区域设置,例如en_US或en_US_WIN
-encoding<name>源文件编码名称
-quiet不显示状态消息
-J<flag>直接将<flag>传递到运行时系统
-X输出非标准选项的提要
通过标准doclet提供:
-d<directory>输出文件的目标目录
-use创建类和程序包用法页面
-version包含@version段
-author包含@author段
-docfilessubdirs递归复制文档文件子目录
-splitindex将索引分为每个字母对应一个文件
-windowtitle<text>文档的浏览器窗口标题
-doctitle<html-code>包含概览页面的标题
-header<html-code>包含每个页面的页眉文本
-footer<html-code>包含每个页面的页脚文本
-top<html-code>包含每个页面的顶部文本
-bottom<html-code>包含每个页面的底部文本
-link<url>创建指向位于<url>的javadoc输出的链接
-linkoffline<url><url2>利用位于<url2>的程序包列表链接至位于<url>的文档
-excludedocfilessubdir<name1>:..排除具有给定名称的所有文档文件子目录。
-group<name><p1>:<p2>..在概览页面中,将指定的程序包分组
-nocomment不生成说明和标记,只生成声明。
-nodeprecated不包含@deprecated信息
-noqualifier<name1>:<name2>:...输出中不包括指定限定符的列表。
-nosince不包含@since信息
-notimestamp不包含隐藏时间戳
-nodeprecatedlist不生成已过时的列表
-notree不生成类分层结构
-noindex不生成索引
-nohelp不生成帮助链接
-nonavbar不生成导航栏
-serialwarn生成有关@serial标记的警告
-tag<name>:<locations>:<header>指定单个参数定制标记
-taglet要注册的Taglet的全限定名称
-tagletpathTaglet的路径
-charset<charset>用于跨平台查看生成的文档的字符集。
-helpfile<file>包含帮助链接所链接到的文件
-linksource以HTML格式生成源文件
-sourcetab<tablength>指定源中每个制表符占据的空格数
-keywords使程序包,类和成员信息附带HTML元标记
-stylesheetfile<path>用于更改生成文档的样式的文件
-docencoding<name>指定输出的字符编码
❽ 什么是注释如何在Java程序中加入注释
试想一下，一个没有一句注释的程序源码，怎么读，一个程序要上万条代码不可能全部记得住哪一块是什么用，而且一个项目也不会是一个人独自完成，那样效率太低，多人合作就要给别人说明，每一块是什么用，方便他人使用，方便自己更正，而这些说明文字就是注释，注释不会被执行，不影响运行结果。
Java中代码的注释有三种：
// 注释一行
/* ...... */ 注释若干行
/** ...... */ 注释若干行，并写入 javadoc 文档
前两种比较容易理解，至于第三种，你学习Java看的api文档就是javadoc程序根据第三种的注释生成的。
(8)java注释设置扩展阅读
注释就是对代码的解释和说明，其目的是让人们能够更加轻松地了解代码。注释是编写程序时，写程序的人给一个语句、程序段、函数等的解释或提示，能提高程序代码的可读性。
❾ eclipse怎么设置创建一个java文件后自动加入注释
eclipse设置创建一个java文件后自动加入注释的方法：
1、通过菜单 Window->Preference 打开参数设置面板，然后选择：
Java -> Code Style -> Code Templates
❿ java注释的自定义
它类似于新创建一个接口类文件，但为了区分，我们需要将它声明为@interface,如下例：
Java代码
packagecom.iwtxokhtd.annotation;
public@interfaceNewAnnotation {
}
使用自定义的注解类型
Java代码
packagecom.iwtxokhtd.annotation;
publicclassAnnotationTest {
@NewAnnotation
publicstaticvoidmain(String[] args) {
}
}
为自定义注解添加变量
Java代码
packagecom.iwtxokhtd.annotation;
public@interfaceAnnotation {
String value();
}
Java代码
publicclassAnnotationTest {
@NewAnnotation(main method)
publicstaticvoidmain(String[] args) {
saying();
}
@NewAnnotation(value = say method)
publicstaticvoidsaying() {
}
}
定义一个枚举类型，然后将参数设置为该枚举类型，并赋予默认值
public@interfaceGreeting {
publicenum FontColor {
BLUE,RED,GREEN
};
String name();
FontColor fontColor()defaultFontColor.RED;
}
这里有两种选择，其实变数也就是在赋予默认值的参数上，我们可以选择使用该默认值，也可以重新设置一个值来替换默认值
Java代码
publicclassAnnotationTest {
@NewAnnotation(main method)
publicstaticvoidmain(String[] args) {
saying();
sayHelloWithDefaultFontColor();
sayHelloWithRedFontColor();
}
@NewAnnotation(say method)
publicstaticvoidsaying() {
}
// 此时的fontColor为默认的RED
@Greeting(name = defaultfontcolor)
() {
}
@Greeting(name = notdefault, fontColor = Greeting.FontColor.BLUE)
() {
} 1.1. 限制注解的使用范围
用@Target指定ElementType属性
Java代码(jdk)
packagejava.lang.annotation;
public enum ElementType {
TYPE,
// 用于类，接口，枚举但不能是注解
FIELD,
// 字段上，包括枚举值
METHOD,
// 方法，不包括构造方法
PARAMETER,
// 方法的参数
CONSTRUCTOR,
//构造方法
LOCAL_VARIABLE,
// 本地变量或catch语句
ANNOTATION_TYPE,
// 注解类型(无数据)
PACKAGE
// Java包
}
1.2. 注解保持性策略
Java代码
//限制注解使用范围
@Target({ElementType.METHOD,ElementType.CONSTRUCTOR})
public @interface Greeting {
//使用枚举类型
public enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() defaultFontColor.RED;
}
在Java编译器编译时，它会识别在源代码里添加的注解是否还会保留，这就是RetentionPolicy。下面是Java定义的RetentionPolicy枚举：
编译器的处理有三种策略：
将注解保留在编译后的类文件中，并在第一次加载类时读取它
将注解保留在编译后的类文件中，但是在运行时忽略它
按照规定使用注解，但是并不将它保留到编译后的类文件中
Java代码
packagejava.lang.annotation;
public enum RetentionPolicy{
SOURCE,
// 此类型会被编译器丢弃
CLASS,
// 此类型注解会保留在class文件中，但JVM会忽略它
RUNTIME
// 此类型注解会保留在class文件中，JVM会读取它
}
Java代码
//让保持性策略为运行时态，即将注解编码到class文件中，让虚拟机读取
@Retention(RetentionPolicy.RUNTIME)
public @interface Greeting {
//使用枚举类型
public enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() defaultFontColor.RED;
}
1.3. 文档化功能
Java提供的Documented元注解跟Javadoc的作用是差不多的，其实它存在的好处是开发人员可以定制Javadoc不支持的文档属性，并在开发中应用。它的使用跟前两个也是一样的，简单代码示例如下：
Java代码
//让它定制文档化功能
//使用此注解时必须设置RetentionPolicy为RUNTIME
@Documented
public @interface Greeting {
//使用枚举类型
public enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() defaultFontColor.RED;
}
1.4. 标注继承
Java代码
//让它允许继承，可作用到子类
@Inherited
public @interface Greeting {
//使用枚举类型
public enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() defaultFontColor.RED;
}
2. 读取注解信息
属于重点，在系统中用到注解权限时非常有用，可以精确控制权限的粒度
注意：要想使用反射去读取注解，必须将Retention的值选为Runtime
Java代码
packagecom.iwtxokhtd.annotation;
importjava.lang.annotation.Annotation;
importjava.lang.reflect.Method;
//读取注解信息
{
publicstaticvoidmain(String[] args)throws Exception {
// 测试AnnotationTest类，得到此类的类对象
Class c = Class.forName(com.iwtxokhtd.annotation.AnnotationTest);
// 获取该类所有声明的方法
Method[] methods =c.getDeclaredMethods();
// 声明注解集合
Annotation[] annotations;
// 遍历所有的方法得到各方法上面的注解信息
for(Method method : methods) {
// 获取每个方法上面所声明的所有注解信息
annotations =method.getDeclaredAnnotations();
// 再遍历所有的注解，打印其基本信息
System.out.println(method.getName());
for(Annotation an :annotations) {
System.out.println(方法名为： + method.getName()+ 其上面的注解为：
+an.annotationType().getSimpleName());
Method[] meths =an.annotationType().getDeclaredMethods();
// 遍历每个注解的所有变量
for(Method meth :meths) {
System.out.println(注解的变量名为： + meth.getName 注释有三种：// /* */ /** */ 前两种编译器直接跳过，从来不阅读，第三种编译器是可以看懂的，当你使用javadoc这样的命令时会用到，用来生成API时用的。
注解：这东东完全就是给编译器看的。 比如@Ovrride表示这个方法是重写了父类中的方法，而不是自定义的，所以这个时候编译器会去检查你的方法名是否和父类一样，是否写错了。
以上是不同的概念
与java注释设置相关的资料
- python列表求交集
- php端口号设置
- phperegreplace
- ssh协议编程
- delphi编程助手
- 加工中心编程结束方法
- 面向对象的编程的基本特征
- php定时执行任务linux
- php数组中删除元素
- java计算12
- javastring字符位置
- php解析xml文档
- java字节截取
- php提交作业
- java毫秒转分钟
- php自适应网站
- c语言javaphp
- java图形图像
- java配置数据库连接
- java多态的体现
- java的split分隔符
- web和php有什么区别
- mainjavasrc
- php批量上传文件夹
- UG编程如何多平面轮廓2D倒角
- php生成静态html页面
- java获取时间gmt时间
- 全自动化编程
- 旅行商问题Python写法
- ubuntu安装软件php
- cnc编程前景怎么样
- java网络编程推荐
- 施耐德开关编程
- 编程就是软件
- 引用指针编程
- java程序升级
- ajax调用java后台
- python操作zookeeper
- python实用工具
- python时间对比
- windows下编译python
- 编程中计算根号的思维