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

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()