Table of Contents

1 IDEA初始化

1.1 格式化

1.1.1 格式化的快捷键

按 “Ctrl+Alt+L”或在代码里输入”}“，代码就会进行格式化。但“Ctrl+Alt+L”会与QQ热键冲突，解决办法是：

1.1.2 Tab转4个空格

一些代码规范会要求编程时使用4个空格缩进而不是tab，好处是在不同编辑器下4个空格的宽度看起来是一致的，而tab则长短不一。
这其实是Idea的默认行为，如下图，默认不勾选“Use tab character”，并设置Indent为4：

1.1.3 列宽不超过120

首先设置 Right margin(columns)：

在File->settings->Code Style->Java中，选中“Wrapping and Braces”选项卡，在“Keep when reformatting”中有一个“Ensure rigth margin is not exceeded”，选中它：

这样，只要按下“Ctrl+Alt+L”就会格式化代码了。

1.2 IntelliJ IDEA 项目结构旁边出现 0%classes,0% lines covered

2 用IDEA生成javadoc文档

-encoding UTF-8 -charset UTF-8 -windowtitle "test"

-encoding：java代码编码
-charset：生成文档所用的编码
-windowtitle：对应html的<title>标签

注意：如果项目中使用了 lombok，默认不会生成get/set方法的。但Lombok提供了delombok供生成Javadoc，delombok在运行时会将注解@Data转换成getter/setter方法，然后移除@Data注解，如果哪天不再需要Lombok，也只需要简单运行delombok即可。

4 使用 maven-javadoc-plugin 插件

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.1.0</version>
    <configuration>
        <show>private</show>
        <aggregate>true</aggregate>
    </configuration>
    <executions>
        <execution>
            <id>attach-javadocs</id>
            <phase>package</phase>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>

4 JavaDoc模板

Idea菜单依次点击 Settings->Editor->File and Code Templates。

4.1 Class、Interface、Enum、AnnotationType

/*
 * Copyright (c) 2018, FalSec Technologies. All rights reserved.
 * FalSec PROPRIETARY/CONFIDENTIAL.
 */
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end

/**
 * @author Hua Wang
 * Created On: ${DATE} ${TIME}
 */
public class ${NAME} {
}