关于IDEA注释格式

开发过程中经常看到源码中的注释，感叹大佬的注释为何写得那么清新脱俗，决定简单研究一下IDEA中的注释

众所周知，Java中的注释标识分为三种：

//       [1]
/* */    [2]
/** */   [3]

第一种是单行注释 //之后的部分皆为注释
第二种和第三种注释可以将注释内容限制在斜杠之间，这是单行注释无法完成的

    public void setNameAndAge(/*名称*/String name, /**年龄*/String age){this.name = name;this.age = age;}

第二种注释用的相对较少
这里主要说一下第三种注释：/** */的情况，这是可以被javadoc所识别的注释，即这种注释可以被JDK中的文档工具所感知，从而实现注释的抽取等操作。
e.g.

我们还可以通过javadoc命令对第三种注释中的内容进行抽取，整合成一个文档，由于这些知识点非常General, 随处可见，不谈。

言归正传，本文只涉及第三种注释，主要内容分为以下部分：

注释的显示状态切换
如何在注释中添加超链接
制表符的添加
IDEA中其它常用的HTML标签

注释状态切换：

之前看大佬们的注释都是:

而我的注释：

为何源码中别人的注释和自己写的注释显示效果完全不一样呢其实是设置问题而已(今天才知道… 尴尬了)

点击图中的铅笔就可以切换为注解源码，效果如下：

再点击图中左上角的图标就切换回了注释的阅览视图

注释中添加超链接的方法：
(1) 使用@see
场景：
有类Student:

package com.test.springbatch.query;import lombok.Data;@Data
public class Student {private String name;private String age;public String pub;public void printWords(String words){System.out.println(words);}
}

在类User的注释中加入指向Student类以及其中属性和方法的超链接:

图中的5个@see注解后的链接分别指向Student类、age属性、pub属性、getName方法、printWords方法需要注意的是#age会被标红，因为age是private的，但这不对链接的功用产生影响
点击左上角的图标切换为阅览视图之后：

此时点击指定的链接即跳转至指定的Class/Field/Method

(2) 使用@link

切换视图后：

plus: 注释中制表符的实现：

加上li标签即可, 效果：

注意：使用<li>时最好用<ul>标签作为其父标签：

/*** <ul>* <li> sss* <li> sss* <li> sss* </ul>*/
public class User {private String name;private String age;public String getName(){return "";}
}

不写<ul>默认也为无序列表
若用<ol>做父标签则为有序列表：

/*** <ol>* <li> sss* <li> sss* <li> sss* </ol>*/
public class User {private String name;private String age;public String getName(){return "";}
}

效果：

除上述的制表符，IDEA中的注释中还可使用其它常用的标签

 ；对Html稍有了解的人都知道这两个标签，效果为使字体倾斜。

/*** hello, today is <em>SUNDAY</em>!* hello, today is <i>SUNDAY</i>!*/
@Data
public class User {public class User {

效果：

图中SUNDAY字样被倾斜显示。

 标签，该标签无特殊显示效果，仅仅作为段落开始的标志

/*** <p>* hello world* * hello world*/
@Data
public class User {

效果：

可见标签下的内容作为一个段落，并不会如原注释般换行

当写为：

/*** <p>* hello world* <p>* hello world*/
@Data
public class User {

效果为：

此时两个hello world从属于不同的,故具有换行效果。
plus: 需要注意，不使用p标签注释文字默认也是不换行的：

/*** hello world* * hello world*/
@Data
public class User {

效果：

<pre class="code"> 标签如同Markdown中写代码需要使用使用代码块一样，注释中若需要写代码的话可用此标签

/*** <pre class="code">*   &#064Configuration*   class A{*     private String name;*     private String age;**   }* </pre>*/
@Data
public class User {

注意，代码块中某些特殊字符需要进行转义处理，图中的&#064是@转义后的字符，否则无法被识别。效果：

End

关于IDEA注释格式相关推荐

Eclipse中java文件头注释格式设置
2019独角兽企业重金招聘Python工程师标准>>> Eclipse中java文件头注释格式设置 Eclipse中java文件头注释格式设置 windows->prefere ...
数据集voc，coco注释格式，详情大全
文章目录前言一.VOC注释格式二.COCO注释格式总结前言啊啊啊啊啊,不太理解任务 (百脸懵逼) 一.VOC注释格式整体结构图片基本信息:例如文件名(folder.filename). ...
Git 使用的一些命令以及Git commit 注释格式
1.Git 快速教程及命令流程: 取代码 → 每次工作前更新代码到最新版本 → 修改代码 → 提交代码到服务器取代码及修改全局设置 a. 设置用户名与邮箱 git config –global u ...
html中的注释格式是,html的注释格式是什么
html的注释格式是"",该格式在开始标签中有一个惊叹号,但是结束标签中没有:并且在浏览器中是不会显示注释的,但是能够帮助记录HTML文档. 本文操作环境:windows7系统.H ...
C/C++常用的文件函数注释格式
下面是我经常使用的两个注释格式,一个用于文件信息注释,一个用于函数信息注释,谢谢大家 /******************************************************** ...
C++编程规范头文件格式和函数注释格式
C++编码规范(1):代码注释当你阅读别人的代码时如果没有注释那会是件比较痛苦的事.一说到注释我们马上想到是通过//或/* */这样来添加一些描述信息.这只是狭义的注释. 广义的注释我们可以理解为, ...
C/C++函数注释格式
目录 C/C++函数注释格式函数注释格式1 函数注释格式2 函数注释格式3 函数注释格式4 函数注释格式5 C/C++函数注释格式函数注释格式1 //======================= ...
java类注释格式模板
java类注释格式模板设置 File -> Settings -> Editor -> File and Code Templates -> 右侧File标签 -> Cl ...
ASPICE SWE3之——模型生成软件详细设计2 注释格式
目录前言注释层级注释方式注释格式功能层(顶层): 时间计划层: 控制流层: 前言前篇已经说到,使用Matlab的print功能导出模型详细设计,相关的配置.若想生成的详细设计内容完整,格式 ...
ASPICE SWE3之——C代码生成软件详细设计2 注释格式
写软件详细设计文档,一般多为有ASPICE要求,写文档真的很费时间,没有要求真的不想写. Doxygen工具就提供了一种通过给代码注释的方式,导出详细设计文档,至于导出什么内容,主要取决于注释的内容. ...

关于IDEA注释格式

关于IDEA注释格式相关推荐

最新文章

热门文章