如何写好java代码注释
1、Java中代码的注释有三种：// 注释一行 /* … */ 注释若干行 /** … */ 注释若干行，并写入 javadoc 文档 前两种比较容易理解，至于第三种，你学习Java看的api文档就是javadoc程序根据第三种的注释生成的。
2、所以，要想写出好的java代码，一定从简短的java代码编写开始注重在java代码后面加上相应的注释，养成良好的习惯。重视排版整洁 看很多java程序员的排版总觉得在欣赏一幅艺术品，但是看到一些java程序员的排版却总觉得无力吐槽。
3、首先你的Java理论基础就不能很差，一个Java理论基础很差的Java程序员，那么你期待他的Java代码水平很好，这是不是有点见鬼了。
4、（2）多行注释：以“/*”开头，以“*/”结尾。 假设当你要说明你所写的代码的功能时。要说明的内容有很多。如果全部放在同一行会显得很难看。
5、写代码的时候，有时候，你需要写一些注释，把内容相互关联起来，方便自己或别人看的时候，可以直接找到你关联的代码类或者啥的。
Java源程序的注释有哪几种类型?
1、Java中三种类型的注释：单行注释：// 注释内容 多行注释：/*… 注释内容…*/ 文本注释：/**.. 注释内容…*/ 代码注释是架起程序设计者与程序阅读者之间的通信桥梁，最大限度的提高团队开发合作效率。
2、单行注释 //注释的内容 多行注释 /*…*/ /**…*/，这种方式和第二种方式相似。这种格式是为了便于javadoc程序自动生成文档。
3、从“/*”开始到“*/”结束，均视为多行注释。文档注释：从“/**”开始到“*/”结束，均视为文档注释。
4、编写注解处理器的核心是AnnotationProcessorFactory和AnnotationProcessor两个接口。后者表示的是注解处理器，而前者则是为某些注解类型创建注解处理器的工厂。
5、另外，你可以在编译时选择代码里的注释是否只存在于源代码级，或者它也能在class文件中出现。
java注解是怎么实现的
1、首先，在我们需要注入依赖的类中使用注解，如：public class MyService { Inject private MyDao dao；// …} 在这个例子中，我们使用了 @Inject 注解来标注一个需要自动注入的属性 dao。
2、要实现节点有属性，value直接赋值，没有子节点的XML格式，可以使用Java的XML注解方式来实现。
3、构造方法上加注解和普通方法加注解是一样的在构造方法定义前加 @注解类型就像行了。public class Car { Deprecated public Car() { } } java语义规定注解类不能定义构造方法。
4、运行时注解，主要通过反射获取注解信息，在执行你想执行的代码 编译期注解，在编译的时候，就已经处理过，运行的时候不会在处理，编译期注解实现需要实现系统的注解处理器。就是说在java代码编译的时候，生成一个新的类。
5、Annotations的用户(同样是一些代码)来读取这些信息并实现必要的逻辑。当我们使用Java的标注Annotations(例如@Override)时，JVM就是一个用户，它在字节码层面工作。到这里，应用开发人员还不能控制也不能使用自定义的注解。
6、注释是用来给开发者或者是软件后续的维护者来看的。一般是用来描述这一段代码或者是程序做了些什么样的事情。实现了哪些功能，java里面注释代码，可以分为行注释和块注释，方法注释等。
如何使用javadoc命令生成api文档,文档注释
使用javadoc有二种方式，一种是嵌入HTML另一种是使用文档标签。所谓文档标签就是一些以 “@”开头的命令，且“@”要置于注释行的最前面。
输入命令：javadoc -d api @package.txt 回车，这样就可以，生成api 帮助文档了。
Javadoc是Java自带的一种工具，其可以从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。
执行命令：mvn javadoc：javadoc 就可以了 所在目录：target/javadoc/apidocs 文档注释是自动生成的，只要你在java文件中写了类以及方法的注释。
java中注释的问题
而这些说明文字就是注释，注释不会被执行，不影响运行结果。
注释是用来给开发者或者是软件后续的维护者来看的。一般是用来描述这一段代码或者是程序做了些什么样的事情。实现了哪些功能，java里面注释代码，可以分为行注释和块注释，方法注释等。
DOC注释/**—*/是完全为javadoc服务的会被编译识别。打头的表示注解，注解这个东西是JDK5提出来的，表示一个类(class)、字段(field)或者方法(method)的属性(attribute)。
第三个是/**……*/ 这个是用来产生帮助文档的。你查看的API文档也是这么生成的。写好源代码以后用javadoc命令。你注释里的内容会自动加入帮助文档。具体内容你去查阅javadoc命令就知道了。
/** */注释的话，你再调用类和方法的时候会出现提示，内容就是你写的注释。就好像文档帮助一样。类似字符串.toString()，鼠标放在toString()上时出现的api说明。而/* */就没有了。
微信扫一扫 
支付宝扫一扫 
