整理文章后提交

2025-01-06 10:57:12 +08:00
1 parent 441dd0e18e
commit 473a07eba4
@@ -1,98 +0,0 @@
-文档书写与命名规范
-
-##### 1. 文档中正文英文单词建议采用 **下划线命名法**，而非大驼峰或小驼峰命名。
-
-示例：
-
-> 要表达的内容:**utopia-doc**
->
-> 反例: **utopiaDoc**或**UtopiaDoc**
->
-> 建议 :**utopia-doc**
-
-文档建议采用 **Markdown** 或 **PDF** 格式
-
-
-
-##### 2. 文档命名尽量不要出现特殊字符字符:
-
-> [!WARNING]
->
-> !@#$%^&*() 
-
-这些符号在不同的环境下兼容无法保证，可能出现意想不到的情况，尤其是: `@` 和 `#` ，在文档作为链接分享时 `@` 和 `#` 不同的软件可能有不同的效果，比如在微信/企业微信中 无法识别 `@` 后的字符
-
-
-
-##### 3. 文档名称命名建议：
-
-1. ###### 文档名称可出现的内容包括：**项目名称**，**文件名称**，**作者名称**，**日期**，**版本**，**语言**
-
-   示例：
-
-   > ProjectName_DocTop_Weiyp_2023-10-10_V1.00.00.0001-beta_CN.pdf
-   
-
-2. ###### 文档名称在不同元素拼接时使用：`_` 或 `-` ，命名采用 **大驼峰命名法**。如:
-
-   > **ProjectName**,**DocTop**
-
-
-
-##### 4. 所有文档文件名称必须以数字编号开始，以方便检索
-
-	如：`1023 - ProjectName_SearchFunction_Test.md`
-
-> 通过定义每个文件的编号以保证新增文件时，其他文件的名字相对不会出现较大范围的移动；并且在大量（一个文件夹下1000个以上）文件时可以更方便检索
-
-
-
-##### 5. 文档文件名称的数字编号不同的内容需要代表不同的含义
-
-	第一位数字可代表不同的文档类型，后三位数字则顺序递增
-
-如：`1` 代表的是 `开发方案`，`2`代表的是 `设计方案`，`3`代表的是`功能测试文档`等等，该部分内容在开发过程中确定，有一些内容并不一定需要。
-
-
-
-##### 6. 代码注释规范
-
- 中文、英文、数字 等不同内容同时在文档中出现时采用空格进行连接。
-
-	示例：
-
-```kotlin
-/**
- * 计算两数之和
- *
- * 传入第一个数： [num1] 和 第二个数字： [num2] 进行累加得出结果
- * 如：num1 为 1 时，num2 为 2 时，计算二者想加得出结果：3
- */
-fun sum(num1:Int, num2:Int) = num1 + num2
-```
-
-	反例：
-
-```kotlin
-/**
- * 计算两数之和
- *
- * 传入第一个数：[num1]和第二个数字：[num2]进行累加得出结果
- * 如：num1为1时，num2为2时，计算二者想加得出结果：3
- */
-fun sum(num1:Int, num2:Int) = num1 + num2
-```
-
-	解释：
-
-> [!NOTE]
->
-> 二者整体来看没有什么区别，主要因为视觉上第一种方式重点更加突出，且能更好的使用鼠标快捷方式
->
-> **鼠标快捷方式**:【该快捷方式在不同编译器中表现不尽相同，但大致遵循该原则】
->
-> 1. 单击：移动光标到指定位置
-> 2. 双击：选中单词
-> 3. 三击：选中对应区域
->
->