JAVA Review-IDE中设置作者日期等Javadoc注释信息

在Java的IDE（Integrated Development Environment,集成开发环境）中，如Eclipse、Spring Tool Suite、IntelliJ IDEA等，都可以设置自动添加的Javadoc注释信息，可以添加@author 作者名、@version 版本标识、@date 日期等，新添加类或方法时会自动添加注释信息，很方便。/*被注释语句/ 就是专为Javadoc设计，可以被JDK内置的Javadoc工具支持和处理，下面就介绍下如何设置Javadoc注释信息和注释的规范。

关键词列表：

@author 作者名
@date 日期
@version 版本标识
@parameter 参数及其意义
@since 最早使用该方法/类/接口的JDK版本
@return 返回值
@throws 异常类及抛出条件
@deprecated 引起不推荐使用的警告
@see reference 查看引用
@override 重写

击菜单中的Window 》Preferences 》Java 》Code Style 》Code Templates，对右侧Comments选项中具体的注释信息进行编辑设置即可。最下面可以勾选上自动添加注释信息，也可以手动插入注释，在类内部或者方法内部，点击菜单中 Source 》 Generate Element Comment，或者使用快捷键 Shift＋Alt＋J。

3、Javadoc注释的规范

附上Javadoc注释的规范，这才是本文的重点，${}的是变量，IDE会自动添加，当然也可以直接改为固定文字。

注释的规范如下：

1、文件注释标签：

/**

• Title: ${file_name}

• Description:

• Copyright: Copyright (c) 2013

• Company: www.izhangheng.com

• @author zhangheng
• @date ${date}
• @version 1.0
  */

2、类型注释标签（类的注释）：

/**

• Title: ${type_name}

• Description:

• Company: www.izhangheng.com

• @author zhangheng
• @date ${date}
  */

3、字段注释标签：

/** ${field}*/

4、构造函数标签：

/**

• Title:

• Description:

• ${tags}
  */

5、方法标签：

/**

• Title: ${enclosing_method}

• Description:

• ${tags}
  */

6、重写方法标签：

/* （非 Javadoc）

• Title: ${enclosing_method}

• Description:

• ${tags}
• ${see_to_overridden}
  */

7、代表方法标签：

/**

• ${tags}
• ${see_to_target}
  */

8、getter方法标签：

/**

• @return ${bare_field_name}
  */

9、setter方法标签：

/**

• @param ${param} 要设置的 ${bare_field_name}
  */

欢迎使用Markdown编辑器

你好！ 这是你第一次使用 Markdown编辑器 所展示的欢迎页。如果你想学习如何使用Markdown编辑器, 可以仔细阅读这篇文章，了解一下Markdown的基本语法知识。

新的改变

我们对Markdown编辑器进行了一些功能拓展与语法支持，除了标准的Markdown编辑器功能，我们增加了如下几点新功能，帮助你用它写博客：

1. 全新的界面设计 ，将会带来全新的写作体验；
2. 在创作中心设置你喜爱的代码高亮样式，Markdown 将代码片显示选择的高亮样式 进行展示；
3. 增加了 图片拖拽 功能，你可以将本地的图片直接拖拽到编辑区域直接展示；
4. 全新的 KaTeX数学公式 语法；
5. 增加了支持甘特图的mermaid语法¹ 功能；
6. 增加了 多屏幕编辑 Markdown文章功能；
7. 增加了 焦点写作模式、预览模式、简洁写作模式、左右区域同步滚轮设置 等功能，功能按钮位于编辑区域与预览区域中间；
8. 增加了 检查列表 功能。

功能快捷键

撤销：Ctrl/Command + Z
重做：Ctrl/Command + Y
加粗：Ctrl/Command + B
斜体：Ctrl/Command + I
标题：Ctrl/Command + Shift + H
无序列表：Ctrl/Command + Shift + U
有序列表：Ctrl/Command + Shift + O
检查列表：Ctrl/Command + Shift + C
插入代码：Ctrl/Command + Shift + K
插入链接：Ctrl/Command + Shift + L
插入图片：Ctrl/Command + Shift + G

合理的创建标题，有助于目录的生成

直接输入1次#，并按下space后，将生成1级标题。
输入2次#，并按下space后，将生成2级标题。
以此类推，我们支持6级标题。有助于使用TOC语法后生成一个完美的目录。

如何改变文本的样式

强调文本 强调文本

加粗文本 加粗文本

标记文本

删除文本

引用文本

H₂O is是液体。

2¹⁰ 运算结果是 1024.

插入链接与图片

链接: link.

图片:

带尺寸的图片:

居中的图片:

居中并且带尺寸的图片:

当然，我们为了让用户更加便捷，我们增加了图片拖拽功能。

如何插入一段漂亮的代码片

去博客设置页面，选择一款你喜欢的代码片高亮样式，下面展示同样高亮的 代码片.

// An highlighted block
var foo = 'bar';

生成一个适合你的列表

• 项目
  • 项目
    • 项目

1. 项目1
2. 项目2
3. 项目3

• 计划任务
• 完成任务

创建一个表格

一个简单的表格是这么创建的：

项目	Value
电脑	$1600
手机	$12
导管	$1

设定内容居中、居左、居右

使用:---------:居中
使用:----------居左
使用----------:居右

第一列	第二列	第三列