From 536afa2b265b32082f89779a60397336f41d9ef9 Mon Sep 17 00:00:00 2001
From: duanluan <duanluan@outlook.com>
Date: Mon, 31 Oct 2022 00:06:37 +0800
Subject: [PATCH] =?UTF-8?q?feat(doc):=20=E6=96=B0=E5=A2=9E=E6=8B=BC?=
 =?UTF-8?q?=E9=9F=B3=E7=89=B9=E6=80=A7=EF=BC=88PinyinFeature=EF=BC=89?=
 =?UTF-8?q?=E7=9A=84=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../pinyin/001-pinyinFeature.md               | 25 +++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 docs/docs/003-reference-doc/pinyin/001-pinyinFeature.md

diff --git a/docs/docs/003-reference-doc/pinyin/001-pinyinFeature.md b/docs/docs/003-reference-doc/pinyin/001-pinyinFeature.md
new file mode 100644
index 0000000..26e29cf
--- /dev/null
+++ b/docs/docs/003-reference-doc/pinyin/001-pinyinFeature.md
@@ -0,0 +1,25 @@
+# PinyinFeature 拼音特性
+
+可以通过临时或总是（Always）修改其静态成员变量，来决定 PinyinUtils 中方法对拼音的处理方式。
+
+## FIRST_WORD_INITIAL_CAP - 第一个单词首字母是否大写
+
+第一个汉字的拼音首字母是否大写，默认为 false。
+
+## SECOND_WORD_INITIAL_CAP - 第二个单词首字母是否大写
+
+后续汉字的拼音首字母是否大写，默认为 false。
+
+## HAS_SEPARATOR_BY_NOT_PINYIN_AROUND - 非拼音前后是否需要分隔符
+
+如果遇到非汉字，传参了分隔符时，非汉字的两侧是否需要此分隔符，默认为 false。
+
+```java
+// 输出结果为 hǎo hǎo xué xí，tiān tiān xiàng shàng，可以看到“，”的两边没有空格
+System.out.println(PinyinUtils.get("好好学习，天天向上", true, true, " "));
+
+// 临时设置非拼音前后需要分隔符
+PinyinFeature.setHasSeparatorByNotPinyinAround(true);
+// 输出结果为 hǎo hǎo xué xí ， tiān tiān xiàng shàng
+System.out.println(PinyinUtils.get("好好学习，天天向上", true, true, " "));
+```
-- 
GitLab