JavaDoc的标准写法-学习common-lang的注释

原创 2016年11月07日 10:33:33

common-lang#StringUtils

类注释

这里写图片描述

简述

功能列表

<ul>
   <li><b>IsEmpty/IsBlank</b>
       - checks if a String contains text</li>
   <li><b>Trim/Strip</b>
       - removes leading and trailing whitespace</li>
   <li><b>Equals</b>
       - compares two strings null-safe</li>
   <li><b>startsWith</b>
       - check if a String starts with a prefix null-safe</li>
   ……

方法注释

这里写图片描述

简述

<p>Checks if a String is empty ("") or null.</p>

例子说明

<pre>
  StringUtils.isEmpty(null)      = true
  StringUtils.isEmpty("")        = true
  StringUtils.isEmpty(" ")       = false
  StringUtils.isEmpty("bob")     = false
  StringUtils.isEmpty("  bob  ") = false
</pre>

弃用@deprecated、参考@see

这里写图片描述
弃用:@deprecated

@deprecated Use the clearer named {@link #trimToEmpty(String)}.Method will be removed in Commons Lang 3.0.

参考:@see

@see java.lang.String#trim()

Java注释的规范写法

一. Java 文档 // 注释一行 /* ...... */ 注释若干行 /** ...... */ 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法如下: /...
  • yumengkk
  • yumengkk
  • 2011年09月26日 11:54
  • 1326

javadoc注释模板设置及详解

设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一...
  • projectNo
  • projectNo
  • 2017年08月01日 10:02
  • 568

详细聊聊Javadoc注释规范

Javadoc 注释规范 1. 注释分类2. Java文档和Javadoc3. 文档注释的格式  3.1 文档和文档注释的格式化3.2 文档注释的三部分 4. 使用Javadoc标记  ...
  • GarfieldEr007
  • GarfieldEr007
  • 2017年02月09日 23:33
  • 2574

如何写Java文档注释(Java Doc Comments)

本文翻译自How to Write Doc Comments for the Javadoc Tool,但是精简了一些私以为不重要的东西 本文不讨论如何使用javadoc工具自动生成文档的方法,而是主...
  • Liuqz2009
  • Liuqz2009
  • 2016年08月09日 15:44
  • 2112

比较全面的函数注释规范

/************************************************************************************************函数名...
  • lfw19891101
  • lfw19891101
  • 2011年04月21日 11:16
  • 9700

成员变量与局部变量、JavaDoc注释

成员变量与局部变量 变量生命的位置决定变量的作用域; 一、何为局部和成员变量 定义在类里的变量叫成员变量 定义在方法里面的变量叫局部变量; 二、成员变量和局部变量的区别: 1.作用域不同 ...
  • jffhy2017
  • jffhy2017
  • 2017年02月03日 15:19
  • 1540

JavaDoc注释

JavaDoc注释类注释/** * 一句话功能描述 * 功能详细描述 * @author [作者] 必须 * @see [相关类/方法] (可选) * @since [产品/模块版本] (必...
  • EthanCo
  • EthanCo
  • 2016年07月23日 11:30
  • 1234

vs2008 多人同时开发项目时的代码注释规范格式

/************************************************       模块:服务器设置       编号:|作者:胜杰|日期:       备注:窗体布...
  • u013816709
  • u013816709
  • 2014年04月23日 14:12
  • 1041

Javadoc 的书写格式和javadoc命令的使用

JAVADOC语法 我们在开发JAVA程序中, 可以使用Javadoc来进行程序文档的整理, 当程序编写完成, 利用Java自带的JavaDoc工具就可以生成规范的API说明手册. 下面是我自己整理的...
  • yongping8204
  • yongping8204
  • 2007年09月23日 10:51
  • 15854

【Javadoc工具】提取注释形成文档

javadoc命令 一、简介 【1】javadoc是用于提取注释的工具,也是JDK安装的一部分,不仅解析由标签标记的信息,也将毗邻注释的类名或方法名抽取出来 【2】所有javadoc命令都...
  • u013107656
  • u013107656
  • 2016年10月07日 16:53
  • 1147
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:JavaDoc的标准写法-学习common-lang的注释
举报原因:
原因补充:

(最多只允许输入30个字)