文档章节

Java-三种注释的用法

吃兔纸不吐毛
 吃兔纸不吐毛
发布于 2017/03/30 15:52
字数 777
阅读 9
收藏 0

一、单行注释

以“//”开头,后面接要说明的内容。使用范围没有什么规定,比如开发前,我们可以用单行注释把思路写下来,开发后,可以把局部说明写下来供后人参考。

比如我们一般在实体类的属性后面用单行注释注明(如下):

public class User implements Serializable{

   private String id;// 自增型ID

   private String username;// 用户名

   private String password;// 用户密码

}

 

善用标记编码时更轻松,使用 TODO 和 FIXME 可以在 Eclipse 编码框右侧显示蓝色标记

// TODO ... 表示此处有功能需要编写

// FIXME ... 表示此处代码需要修正

 

二、多行注释

又称为块注释,可以把一部分代码块注释掉,使用范围不太清楚,但是我一般都拿来注释代码。

比如我们要注释一个判断的一部分,用多行注释就很方便(如下):

if (null != password /* && password.trim() != "" */) {
    return "ok";
}

 

三、文档注释

文档注释用得比较少,但是很方便,尤其是他自带的那些标签,我个人的建议是加在认为有必要加注释的方法、类、接口、全局变量等上面,因为在Eclipse中把鼠标移动到方法上,会显示出写了文档注释的说明,很实用(如下):

 

1. 文档注释标签语法

下图转自:http://c.biancheng.net/cpp/html/1761.html

 

 

 

 

 

 

 

 

 

 

 

 

 


 

2. 嵌入式HTML标签

作用是对复杂的文档注释进行格式化,我在看某些官方文档的时候发现的,可以让文档注释更容易读懂,就像我上面图里的,就是用了嵌入式HTML标签,不然文档显示出来时早就挤在一起了,非常难读懂(如下):

/**
 * <p>session状态</p>
 * 
 * <pre>
 * key="sessionDestroyedStatus"(session销毁时的状态): 
 * value="busy": 异地登陆; 
 * value="timeout": 超时自动销毁; 
 * value="logout": 手动退出
 * <pre>
 */
public static Map<String, String> sessionStatusMap = new HashMap<String, String>();

这个我找得不全,我就说一下我用过的几种,总体的用法都是和HTML差不多的:

<p></p>                                    定义段落

<pre></pre>                             定义预格式化的文本

<code></code>                        暗示着这段文本是源程序代码

<i></i>                                      鼠标悬浮上方显示斜体文本效果,与<em></em>显示效果类似

<br>                                           换行

<em></em>                             表示为强调的内容,把这段文字用斜体来显示

<blockquote></blockquote>   标记长的引用,在 blockquote 元素前后添加了换行,并增加了外边距

<h1></h1>                               <h1>~<h6>,都显示加粗,不会变大

<strong></strong>                   加粗

<ul></ul>                                  配合<li></li>使用,和HTML一样,很方便

加红的显示效果和普通的迥异,个人认为平时使用足矣。

 

© 著作权归作者所有

吃兔纸不吐毛
粉丝 5
博文 63
码字总数 31925
作品 0
杭州
私信 提问
第一章:groovy 的语法和用法习惯

我们将介绍 groovy 语言的基础知识, 使用 groovy 需要知道的两件事:代码外观和断言。 我是看着Groovy in Action的时候,写这个博客的。所以很多东西是从里面复制出来的,希望大家去看原书。...

supperman
2012/11/16
657
0
正则表达式抽取去java中的注释

最近要做一个小项目要抽取JAVA源代码中的注释部分 我们知道Java中有3中注释 //单行注释 /*单行或多行注释*/ /** *多行注释 */ 请问这三种注释抽取的正则式怎么写

dh_
2012/12/02
1K
2
java连接各种数据库(mysql,sql server,oracle,db2)

MYSQL: private String conUrl ="jdbc:mysql://localhost:3306/数据库"网站推广 Class.forName("com.mysql.jdbc.Driver"); conn = DriverManager.getConnection(conUrl,"用户名","密码"); S......

网络营销
2012/01/09
277
0
Java 注释技巧【总结的不错】

Java 注释技巧 在最初学习Android时候使用了Eclips IDE工具,编写java程序时,总是要添加一些注释,用以说明某段代码的作用,由于是从C过度来的,也没有太在意java的注释有何不同,将鼠标移动...

Airship
03/13
22
0
JsDoc Toolkit 简介

JsDoc Toolkit 是一款辅助工具,你只需要根据约定在 JavaScript 代码中添加相应的注释,它就可以根据这些注释来自动生成API文档。对Java 熟悉的人可能会发现它和 Java 的文档自动化工具 Java...

红薯
2009/10/16
2.5K
1

没有更多内容

加载失败,请刷新页面

加载更多

可见性有序性,Happens-before来搞定

写在前面 上一篇文章并发 Bug 之源有三,请睁大眼睛看清它们 谈到了可见性/原子性/有序性三个问题,这些问题通常违背我们的直觉和思考模式,也就导致了很多并发 Bug 为了解决 CPU,内存,IO ...

tan日拱一兵
14分钟前
2
0
网络七层模型与TCP/UDP

为了使全球范围内不同的计算机厂家能够相互之间能够比较协调的进行通信,这个时候就有必要建立一种全球范围内的通用协议,以规范各个厂家之间的通信接口,这就是网络七层模型的由来。本文首先...

爱宝贝丶
18分钟前
2
0
Jenkins World 贡献者峰会及专家答疑展位

本文首发于:Jenkins 中文社区 原文链接 作者:Marky Jackson 译者:shunw Jenkins World 贡献者峰会及专家答疑展位 本文为 Jenkins World 贡献者峰会活动期间的记录 Jenkins 15周岁啦!Jen...

Jenkins中文社区
36分钟前
8
0
杂谈:面向微服务的体系结构评审中需要问的三个问题

面向微服务的体系结构如今风靡全球。这是因为更快的部署节奏和更低的成本是面向微服务的体系结构的基本承诺。 然而,对于大多数试水的公司来说,开发活动更多的是将现有的单块应用程序转换为...

liululee
50分钟前
7
0
OSChina 周二乱弹 —— 我等饭呢,你是不是来错食堂了?

Osc乱弹歌单(2019)请戳(这里) 【今日歌曲】 @ 自行车丢了:给主编推荐首歌 《クリスマスの夜》- 岡村孝子 手机党少年们想听歌,请使劲儿戳(这里) @烽火燎原 :国庆快来,我需要长假! ...

小小编辑
今天
534
9

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部