单行注释、多行注释与文档注释
单行注释
//注释内容
多行注释
/*
int c = 10;
int x = 5;
*/
文档注释
/**
注释内容
注释内容
*/
多行注释与文档注释的区别
文档注释的内容可以生产一个开发者文档。
使用javadoc开发工具即可生成一个开发者文档。
javadoc工具的使用格式:
javadoc -d 存放文档的路径 java的源文件
使用javadoc工具注意事项:
1.如果一个类需要使用javadoc工具生成一个软件的开发者文档,那么该类必须使用public修饰。
2.文档注释的内容一般都是位于类或者方法的上面。
写注释的规范:一般单行注释是位于代码的右侧,多行注释与文档注释一般是写在类或者方法上面的。