JavaDoc
的方式来写Java Doc
的注释(单行 多行注释),往往是给代码维护者看的,着重告诉读者为什么这样写,如何修改,注意什么问题等。Tab
操作,实现缩进,默认整体向右, 而用Shift + Tab
则整体向左移动。=
两边习惯性的各加一个空格。例如 : int result = 2 + 3
UTF-8
编码80
字符次行风格
或 行尾风格
行尾风格:
public class Hello { public static void main (String[] args) { System.out.println("Hello World"); } }
次行风格:
public class Hello { public static void main (String[] args) { System.out.println("Hello World"); } }
单行注释
// 这是单行注释
多行注释
/* 这是多行注释 在*与*之间填充的字符都是注释 */
文档注释
文档注释能使用javadoc
生成一套以网页形式体现该程序的说明文档,一般写在类里
/** * @author 作者名称 * @version 版本号 */ // 文档注释比多行注释多了一个*且每行行首都有一个* // 还有其他标签参考下面链接
多行注释生成命令:javadoc -d SAVE_PATH 使用到的标签如(-author -version) CODE_PATH
JavaDoc细节