Java day03 三种注释的写法和javadoc.exe生成api

单行注释

ctrl + / 添加取消行注释

按下 alt + 鼠标 左键可以列选择多行处理

可以在File>>Settings>>Editor>>Code Style>>Java>>Code Generotion

取消勾选Line comment  at first column

这样注释就在语句前边了，当语句较多时，就会显得比较整洁（大家可以按照自己的喜好来）

多行注释，块注释

ctrl + / 

或者 /*+enter（不推荐）

文档注释

ctrl+shift+/

/ * * + enter

可以表明作者、版本等信息

可以在设置中设置类模板，这样以后写项目，文档注释就可以自动生成了

File>>Settings>>Editor>>File and Code Templatec>>lncludes

1 建立 File Top
/*
 * Copyright (c) 2006, ${YEAR},联系方式 All rights reserved.
 *
 */


2 添加File Header 
/**
 *
 * <p>Project: ${PROJECT_NAME} - ${NAME}</p>
 * <p>Powered by webrx On ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}:${SECOND}</p>
 * <p>描述：<p>
 * @author 自己id [邮箱等]
 * @version 1.0
 * @since   17
 */

 

找到类模板
#parse("File Top.java")
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
public class ${NAME} {
    public static void main(String[] args){
		        
    }
}

这样新建java文件就会自动生成我们设置的注释了

各种注释和类的结构属性和一个 javadoc.exe 命令相关，javadoc 命令可以根据文字的这些信息，快速生成类的 api 参考网页。

Tools>>Generate JavaDoc...

 到这里就结束啦！