本文章主要包括以下6个内容:

一、注释分类以及javadoc的使用

二、使用Alibaba Java Coding Guidelines规范编码。

三、IDEA配置类注释

四、IDEA配置方法注释

====================正文开始====================


一、注释分类以及javadoc的使用。

  所谓注释就是只给人看的,而并不会被执行的语句。适当的代码注释可以提高代码可读性,也方便后期的维护,所以在编程初期就要养成良好的编码习惯。代码注释分为一下三种:

  1、单行注释:      // ……单行注释。

  2、多行注释:     /* ...... */ 多行注释,注释内容不会出现在javadoc 生成的文档中。

  3、文档注释 :        /** ...... */ 多行注释,注释内容写入javadoc生成的文档。

这三种注释的具体使用可使用Alibaba Java Coding Guidelines插件进行学习。详见第二大点。

  3.1javadoc生产API文档

  可参见官方文档:https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html

  这里对Two.java文件进行生产API文档

  Two.java文件的文件内容为:

 1 /**
2 * @author ThreePure
3 * @date 20/9/16 8:52
4 * @description:输出Hello World
5 * @since 1.8
6 */
7 public class Two {
8 public static void main(String[] args) {
9 System.out.println("Hello World");
10 }
11 }

  在java文件中运行cmd命令行窗口,执行:javadoc -encoding UTF-8 -charset UTF-8 Two.java

  生成后文件内容为

   这里打开index.html文件就可以查看产生的API文档。

二、使用Alibaba Java Coding Guidelines规范编码。

  2.1了解什么是Alibaba Java Coding Guidelines?

  Alibaba Java Coding Guidelines是阿里巴巴于2017年10月14日在杭州云栖大会上,正式发布众所期待的《阿里巴巴Java开发规约》扫描插件!该插件由阿里巴巴P3C项目组研发。P3C是世界知名的反潜机,专门对付水下潜水艇,寓意是扫描出所有潜在的代码隐患。这个项目组是阿里巴巴开发爱好者自发组织形成的虚拟项目组,把《阿里巴巴Java开发规约》强制条目转化成自动化插件,并实现部分的自动编程。

  简单的说就是一个编程时的规则,使代码更加的美观可读。特别是对呀一些编程小白,能够从一开始就养成良好的编程习惯。

  阿里巴巴基于手册内容,研发了一套自动化的IDE检测插件(IDEA、Eclipse)。该插件在扫描代码后,将不符合规约的代码按Blocker/Critical/Major三个等级显示在下方。甚至在IDEA上,还基于Inspection机制提供了实时检测功能,编写代码的同时也能快速发现问题所在。对于历史代码,部分规则实现了批量一键修复的功能。极大的提高了代码质量。

  2.2 在IDEA中安装Alibaba Java Coding Guidelines Plugins 。

  安装完成后有多种方式使用。

  点击编码规约扫描,扫描结果可能出现类似下图的结果:

  根据bug的严重程度,优先级定义了Blocker,Critical,Major,Minor/Trivial几个等级。单击即可查看相应的规则和建议。

  归于新手而言最好的功能还是它能实时地检查你书写的代码,并且在右侧实时给出警告,而且警告也是汉字。在你书写的代码中只要存在不符合规范的地方就会用黄色的波浪线显示出来,当鼠标放上去,就会显示相应的提示信息。

  阿里规范代码已经开源,GitHub:https://github.com/alibaba/p3c

三、IDEA配置类注释

  我的内容是:

/**
* @author username
* @date ${DATE} ${TIME}
* @since 1.8
* @description:TODO
*/
设置完成后在以后每次新建类时都会自动产生该注释。

四、IDEA配置方法注释

  方法注释的设置跟类注释基本一致。打开Settings=》Editor=》Live Templates。选择右侧的+号,选择Templates Group。

  弹出一下窗口,输入想要的组名即可:

  2,选择刚刚建好的组,点击右侧+号,点击Live Template

  创建一个新的模板:

    Abbreviation:是缩写的意思,也就是在需要产生这个注释的地方输入这个内容,摁下回车(也可以根据By default expand with属性选择其他键),就可以产生注释。建议越短越好。

    Description:添加一个描述信息,只是为了方便知道这个缩写用来干嘛的。

T    emplate text:输入模板。这里特别注意当输入一个变量时,比如图中的date,time,param以及return,这些是变化的,当IDEA识别到输入了变量时,需要在右边的Edit variables中添加函数才能有效。注意这里需要区别设置类方法时的{DATE},这里不需要{}。

  我这里设置模板内容为:

/**
* @author username
* @date $date$ $time$
* @description:
* @Param:$param$
* @Return:$return$
*/

  Expression具体设置参照下图

  这里解释一下param和return两个变量,param是指参数,也就是这个方法会有哪些参数,return是指返回类型。但是需要自动产生这两个值,就必须在方法内部使用。如果在方法外部使用,将无法获得这两个参数。

Java注释相关以及IDEA配置相关的注释的更多相关文章

  1. Java Servlet(二):servlet配置及生命周期相关(jdk7+tomcat7+eclipse)

    该篇文章记录了Servlet配置相关用法及Servlet在Servlet容器中生命周期方法. Tomcat是一个Servlet容器: 1.Servlet容器管理了Servlet的整个生命周期,并调用s ...

  2. Hibernate 系列 04 - Hibernate 配置相关的类

    引导目录: Hibernate 系列教程 目录 前言: 通过上一篇的增删改查小练习之后,咱们大概已经掌握了Hibernate的基本用法. 我们发现,在调用Hibernate API的过程中,虽然Hib ...

  3. Linux下Openfire相关安装和配置

    记录下来,方便下次再用时从头查找资料 小京东ecshop中的通讯有用到openfire,Window下配置安装很简单,直接下载exe文件安装就行,而linux下要麻烦一点.安装后的配置下面会细说: 一 ...

  4. linux网络配置相关文件

    网络接口(interface)是网络硬件设备在操作系统中的表示方法,比如网卡在Linux操作系统中用ethX,是由0开始的正整数,比如eth0.eth1...... ethX.而普通猫和ADSL的接口 ...

  5. Tomcat 参数配置相关

    Tomcat参数配置相关 by:授客 QQ:1033553122 目的: 对Tomcat配置的点滴学习总结,主要目的在于分析Tomcat与性能相关的一些参数设置,以便性能调优时选择最优配置   环境: ...

  6. 【树莓派】服务配置相关3:基于Ubuntu Server的服务配置

    该文接续之前写过的两篇: [树莓派]服务配置相关 [树莓派]服务配置相关2:基于RPi Desktop的服务配置 这是我个人用来进行树莓派盒子安装配置的脚本,对于外部其他博友,可以部分参考,但不需要逐 ...

  7. 【solr】schemaFactory配置相关schema.xml

    schemaFactory配置相关schema.xml  关于schemaFactory的配置困扰我半天啦,下面来总结一下. 话说,好像是从5.0以后就已经没有schema.xml啦,这是由于Solr ...

  8. linux网络配置相关命令、虚拟网络接口eth0:0

    网络接口(interface)是网络硬件设备在操作系统中的表示方法,比如网卡在Linux操作系统中用ethX,是由0开始的正整数,比如eth0.eth1...... ethX.而普通猫和ADSL的接口 ...

  9. GBrowse配置相关资料

    GBrowse配置相关资料(形状.颜色.配置.gff3) http://gmod.org/wiki/Glyphs_and_Glyph_Optionshttp://gmod.org/wiki/GBrow ...

随机推荐

  1. suse 12 二进制部署 Kubernetets 1.19.7 - 第12章 - 部署dashboard插件

    文章目录 1.12.0.创建namespace 1.12.1.创建Dashboard rbac文件 1.12.2.创建dashboard文件 1.12.3.查看pod以及svc 1.12.4.获取 d ...

  2. Spring Data JPA应用之常规CRUD操作初体验

    基于对于一个陌生的技术框架,先使用后研究其实现的原则(大部分本人如此,就如小朋友学习骑自行车不会先研究自行车是怎么动起来的而是先骑会了),对于Spring JPA先通过案例实践其怎么用吧. 用之前得明 ...

  3. Python中random模块的用法案例

    1 import random # 调用random模块 2 3 a = random.random() # 随机从0-1之间抽取一个小数 4 print(a) 5 6 a = random.rand ...

  4. kali linux安装nessus

    详细介绍在 Kali 中安装 Nessus 的详细过程步骤以及插件下载失败解决方法. 实验环境 安装过程 下载 Nessus 安装 Nessus 启动 Nessus 获取激活码 登陆 web 界面 N ...

  5. [error]subprocess.CalledProcessError: Command '['which', 'g++']' returned non-zero exit status 1.

    ubuntu 20.04 上安装 mmcv-full 时,无论是执行: pip install mmcv-full 还是将 mmcv-full 项目克隆下来编译,均会出现问题. 百度无果,去必应上逛了 ...

  6. 为什么说国产BI更适合国内企业?

    ​就算国外BI发展迅速,产品更加完善成熟,但对国内的企业来说,使用起来难免"水土不服",何况还有服务对接过程中的繁琐程.今天就来讨论一下,国内BI和国外BI到底该怎么选择? 国外B ...

  7. 【C#特性】 Attribute 特性

    msdn:https://docs.microsoft.com/zh-cn/dotnet/csharp/programming-guide/concepts/attributes/creating-c ...

  8. Git——版本控制器概述

    一.版本控制 版本控制(Revision contontrol)是一种在开发过程中用于管理修改历史,方便查看更改历史记录,备份以便恢复以前版本的软件工程的技术. 1.实现跨区域多人协同开发 2.追踪和 ...

  9. 如何在 Spring Boot 优雅关闭加入一些自定义机制

    个人创作公约:本人声明创作的所有文章皆为自己原创,如果有参考任何文章的地方,会标注出来,如果有疏漏,欢迎大家批判.如果大家发现网上有抄袭本文章的,欢迎举报,并且积极向这个 github 仓库 提交 i ...

  10. 【计题04组01号】Java面试问答题

    写作前面 本书内容摘自<Java程序员面试笔试宝典> 很多同学在面试时其实有个误区,认为准备的东西越详细越好 其实不是,就和批试卷一样,写长篇大论其实并不会必然加分 老师阅卷时间有限只会抓 ...