lsm/hutool
1
0
Fork 0
mirror of https://gitee.com/dromara/hutool.git synced 2025-04-05 17:37:59 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

add comments to StrUtil

Browse Source 
补全常量注释
This commit is contained in:
Singu 2020-10-13 17:04:02 +08:00
parent 43152af8be
commit a9e1b77b2c
1 changed files with 109 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

153
hutool-core/src/main/java/cn/hutool/core/util/StrUtil.java
View File

@ -36,180 +36,245 @@ public class StrUtil {
public static final int INDEX_NOT_FOUND = -1;
/**
* 字符常量：空格符 ' '
* 字符常量：空格符 {@code ' '}
*/
public static final char C_SPACE = CharUtil.SPACE;
/**
* 字符常量：制表符 \t
* 字符常量：制表符 {@code '\t'}
*/
public static final char C_TAB = CharUtil.TAB;
/**
* 字符常量：点 .
* 字符常量：点 {@code '.'}
*/
public static final char C_DOT = CharUtil.DOT;
/**
* 字符常量：斜杠 /
* 字符常量：斜杠 {@code '/'}
*/
public static final char C_SLASH = CharUtil.SLASH;
/**
* 字符常量：反斜杠 \
* 字符常量：反斜杠 {@code '\\'}
*/
public static final char C_BACKSLASH = CharUtil.BACKSLASH;
/**
* 字符常量：回车符 \r
* 字符常量：回车符 {@code '\r'}
*/
public static final char C_CR = CharUtil.CR;
/**
* 字符常量：换行符 \n
* 字符常量：换行符 {@code '\n'}
*/
public static final char C_LF = CharUtil.LF;
/**
* 字符常量：下划线 _
* 字符常量：下划线 {@code '_'}
*/
public static final char C_UNDERLINE = CharUtil.UNDERLINE;
/**
* 字符常量：逗号 ,
* 字符常量：逗号 {@code ','}
*/
public static final char C_COMMA = CharUtil.COMMA;
/**
* 字符常量：花括号（左） {
* 字符常量：花括号（左） <code>'{'</code>
*/
public static final char C_DELIM_START = CharUtil.DELIM_START;
/**
* 字符常量：花括号（右） }
* 字符常量：花括号（右） <code>'}'</code>
*/
public static final char C_DELIM_END = CharUtil.DELIM_END;
/**
* 字符常量：中括号（左） [
* 字符常量：中括号（左） {@code '['}
*/
public static final char C_BRACKET_START = CharUtil.BRACKET_START;
/**
* 字符常量：中括号（右） ]
* 字符常量：中括号（右） {@code ']'}
*/
public static final char C_BRACKET_END = CharUtil.BRACKET_END;
/**
* 字符常量：冒号 :
* 字符常量：冒号 {@code ':'}
*/
public static final char C_COLON = CharUtil.COLON;
/**
* 字符常量：艾特 @
* 字符常量：艾特 <code>'@'</code>
*/
public static final char C_AT = CharUtil.AT;
/**
* 字符串常量：空格符 ' '
* 字符串常量：空格符 {@code " "}
*/
public static final String SPACE = " ";
/**
* 字符串常量：制表符 \t
* 字符串常量：制表符 {@code "\t"}
*/
public static final String TAB = " ";
/**
* 字符串常量：点 .
* 字符串常量：点 {@code "."}
*
* @since 1.0.0
*/
public static final String DOT = ".";
/**
* 字符串常量：双点 ..
* 用途：作为指向上级文件夹的路径 "../path"
* 字符串常量：双点 {@code ".."} <br />
* 用途：作为指向上级文件夹的路径，如：{@code "../path"}
*/
public static final String DOUBLE_DOT = "..";
/**
* 字符串常量：斜杠 /
* 字符串常量：斜杠 {@code "/"}
*
* @since 1.0.0
*/
public static final String SLASH = "/";
/**
* 字符串常量：反斜杠 \
* 字符串常量：反斜杠 {@code "\\"}
*/
public static final String BACKSLASH = "\\";
/**
* 字符串常量：空字符串 ""
* 字符串常量：空字符串 {@code ""}
*
* @since 1.0.0
*/
public static final String EMPTY = "";
/**
* 字符串常量："null"
* 注意："null" != null
* 字符串常量：{@code "null"} <br />
* 注意：{@code "null" != null}
*/
public static final String NULL = "null";
/**
* 字符串常量：回车符 \r
* 字符串常量：回车符 {@code "\r"} <br />
* 解释：该字符常用于表示 Linux 系统和 MacOS 系统下的文本换行
*/
public static final String CR = "\r";
/**
* 字符串常量：换行符 \n
* 字符串常量：换行符 {@code "\n"}
*
* @since 1.0.0
*/
public static final String LF = "\n";
/**
* 字符串常量：Windows 换行 \r\n
* 字符串常量：Windows 换行 {@code "\r\n"} <br />
* 解释：该字符串常用于表示 Windows 系统下的文本换行
*
* @since 1.0.0
*/
public static final String CRLF = "\r\n";
/**
* 字符串常量：下划线 _
* 字符串常量：下划线 {@code "_"}
*/
public static final String UNDERLINE = "_";
/**
* 字符串常量：减号（中划线） -
* 字符串常量：减号（连接符） {@code "-"}
*/
public static final String DASHED = "-";
/**
* 字符串常量：逗号 ,
* 字符串常量：逗号 {@code ","}
*/
public static final String COMMA = ",";
/**
* 字符串常量：花括号（左） {
* 字符串常量：花括号（左） <code>"{"</code>
*/
public static final String DELIM_START = "{";
/**
* 字符串常量：花括号（右） }
* 字符串常量：花括号（右） <code>"}"</code>
*/
public static final String DELIM_END = "}";
/**
* 字符串常量：中括号（左） [
* 字符串常量：中括号（左） {@code "["}
*/
public static final String BRACKET_START = "[";
/**
* 字符串常量：中括号（右） ]
* 字符串常量：中括号（右） {@code "]"}
*/
public static final String BRACKET_END = "]";
/**
* 字符串常量：冒号 :
* 字符串常量：冒号 {@code ":"}
*/
public static final String COLON = ":";
/**
* 字符串常量：艾特 @
* 字符串常量：艾特 <code>"@"</code>
*/
public static final String AT = "@";
/**
* 字符串常量：HTML 空格转义
* 字符串常量：HTML 空格转义 {@code "&nbsp;" -> " "}
*
* @since 1.0.0
*/
public static final String HTML_NBSP = "&nbsp;";
/**
* 字符串常量：HTML And 符转义 &amp;
* 字符串常量：HTML And 符转义 {@code "&amp;" -> "&"}
*
* @since 1.0.0
*/
public static final String HTML_AMP = "&amp;";
/**
* 字符串常量：HTML 双引号转义 "
* 字符串常量：HTML 双引号转义 {@code "&quot;" -> "\""}
*
* @since 1.0.0
*/
public static final String HTML_QUOTE = "&quot;";
/**
* 字符串常量：HTML 单引号转义 '
* 字符串常量：HTML 单引号转义 {@code "&apos" -> "'"}
*/
public static final String HTML_APOS = "&apos;";
/**
* 字符串常量：HTML 小于号转义 &lt;
* 字符串常量：HTML 小于号转义 {@code "&lt;" -> "<"}
*
* @since 1.0.0
*/
public static final String HTML_LT = "&lt;";
/**
* 字符串常量：HTML 大于号转义 &gt;
* 字符串常量：HTML 大于号转义 {@code "&gt;" -> ">"}
*
* @since 1.0.0
*/
public static final String HTML_GT = "&gt;";
/**
* 字符串常量：空 JSON "{}"
* 字符串常量：空 JSON <code>"{}"</code>
*
* @since 1.0.0
*/
public static final String EMPTY_JSON = "{}";
// ------------------------------------------------------------------------ Blank
/**