整理代码规范说明

2021-09-05 18:07:45 +08:00
parent 8c9fd45fcc
commit 395485527e
1 changed files with 14 additions and 7 deletions
--- a/.github/contributing.md
+++ b/.github/contributing.md
@@ -42,14 +42,21 @@ do
    s
 end
 ```
-## 单行注释
-    写在函数定义行/单行代码末尾/代码块前面第一行
-## 多行注释
-    用双方括号(等号能不带就不带),写在函数或者一堆函数的前面
-    方括号开头行带上几个字的概述,方便折叠的时候预览
+## 单行/多行注释
+```lua
+单行代码--注释1
+
+--注释2
+函数或者代码块
+
+--[[这里最好带上几个字的概述,方便折叠的时候预览,方括号间等号能不带就不带
+    注释内容
+]]
+函数或者代码块
+```
 ## 字符串
-    只存在于代码里不展示给玩家的字符串用单引号
-    会输出给玩家或者看的(或给开发者看的debug信息)用双引号
+    可能输出到外部给玩家或者看的(或给开发者看的debug信息)用双引号
+    只存在于代码中不对外展示的字符串用单引号
    双方括号(等号能不带就不带)用于大段文本
 ## 代码紧凑
 ### 少空格(这几种地方不要用空格)