更新文档 #19

renweibo · May 11, 2022 · 666edb0 · 666edb0
1 parent 24aa32e
commit 666edb0
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/docs/error_info.md b/docs/error_info.md
@@ -0,0 +1,23 @@
+# 汇总所有的错误信息
+
+## 2003：源代码中有的 item 没有对应的翻译
+
+```json
+{
+  "No": "2003",
+  "Level": "错误",
+  "Scope": "单个翻译项",
+  "Name": "源代码中有的 item 没有对应的翻译",
+  "Data": {
+    "type": "item",
+    "key_name": "xxxx",
+    "key_value": "xxxx",
+    "info": "",
+    "file_position": ["xxx/xxx.java#123", "xxx/xxx.jsp#13"]
+  },
+  "Comment": ""
+}
+```
+
+`xxx/xxx.java#123`，#号前面是文件名，后面是行号
+
diff --git a/docs/rule/G2003.md b/docs/rule/G2003.md
@@ -4,6 +4,8 @@
 
 本规则适用于单条翻译项，主要检查的是源代码里的翻译项使用情况，如果发现某条翻译项在源代码中有，但是对于的语言文件中没有对应的翻译项，意味着显示的时候，会找不到合适的翻译项，这时会产生一条编号为 2003 的错误检查信息。
 
+本条规则会产生[错误信息 2003](../error_info.md#2003：源代码中有的 item 没有对应的翻译)
+
 这种情况一般意味着错误，只有个别情况，比如有些代码在注释中，还有些不再有效的代码里。
 
 实现上，可以参考的方式是，先通过语法解析器或简单点正则表达式，从源代码中找出所有可能的翻译项，得到使用的翻译项集合，再把这个集合和翻译文件中的翻译项集合做一下比较，就可以知道哪些翻译项有缺失。