Skip to content

Commit e696bdf

Browse files
yql70yql70
authored
Merge pull request #605 from yalechen-cyw/feature/license
 📝 Add TCA-Armory-C1 Doc
2 parents 5da2856 + ec7a770 commit e696bdf

4 files changed

Lines changed: 70 additions & 0 deletions

File tree

‎doc/.vuepress/configs/sidebar/en.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ export const en: SidebarConfig = {
2828
'/en/guide/代码检查/工具/eslint.md',
2929
'/en/guide/代码检查/工具/golangcilint.md',
3030
'/eh/guide/代码检查/工具/TCA-Armory-R.md',
31+
'/eh/guide/代码检查/工具/TCA-Armory-C1.md',
3132
],
3233
},
3334
]

‎doc/.vuepress/configs/sidebar/zh.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ export const zh: SidebarConfig = {
2828
'/zh/guide/代码检查/工具/eslint.md',
2929
'/zh/guide/代码检查/工具/golangcilint.md',
3030
'/zh/guide/代码检查/工具/TCA-Armory-R.md',
31+
'/zh/guide/代码检查/工具/TCA-Armory-C1.md',
3132
],
3233
},
3334
]

‎doc/en/guide/代码检查/工具/TCA-Armory-C1.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# TCA-Armory-C1 使用手册
2+
3+
TCA-Armory-C1 属于 TCA 的增强分析模块。
4+
5+
## 功能
6+
- Objective-C/C++ 代码规范
7+
- C/C++/Java 代码安全
8+
9+
## 准备
10+
- 需要事先部署好 [CLS 微服务](https://tencent.github.io/CodeAnalysis/zh/quickStarted/enhanceDeploy.html)
11+
12+
## 规则
13+
| 规则 | 概览 | 参数 | 参数示例 |
14+
| :-------- | :------- | :------- | :------- |
15+
| ObjectiveC/Copyright | 检查代码文件的copyright信息 | 无 | 无 |
16+
| ObjectiveC/Indent | 检查代码文件的缩进 | IndentStyle: 可选 spaces 空格 和 tabs `\t` ，默认是 spaces <br> IndentSize: 缩进长度，默认是4 | IndentStyle=spaces <br> IndentSize=4 |
17+
| ObjectiveC/MaxLinesPerFunction | 检查超出行数长度阈值的函数 | LineThreshold: 方法长度阈值，默认是100 | LineThreshold=100 |
18+
| ObjectiveC/MissingDocInterface | 检查接口需要注释信息 | 无 | 无 |
19+
| ObjectiveC/MissingDocProperty | 检查属性是否有注释 | 无 | 无 |
20+
| ObjectiveC/MissingDocProtocol | 检查protocol是否有注释 | 无 | 无 |
21+
| ObjectiveC/ParameterCount | 检查方法的参数个数 | Max: 参数个数阈值，默认是6 | Max=6 |
22+
| ObjectiveC/ClassNaming | 检查class命名格式 | ClassCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 CamelCase ｜ ClassCase=CamelCase |
23+
| ObjectiveC/FunctionNaming | 检查函数命名格式 | FunctionCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 camelBack | FunctionCase=camelBack |
24+
| ObjectiveC/GlobalVariableNaming | 检查全局变量的命名格式 | GlobalVariablePrefix: 全局变量前缀，默认是`g` <br> GlobalVariableCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 camelBack | GlobalVariablePrefix=g <br> GlobalVariableCase=camelBack |
25+
| ObjectiveC/LocalVariableNaming | 检查局部变量的命名格式 | LocalVariableCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 camelBack | LocalVariableCase=camelBack |
26+
| ObjectiveC/MacroNaming | 检查macro命名格式 | MacroCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 UPPER_CASE | MacroCase=UPPER_CASE |
27+
| ObjectiveC/MaxLineLength | 检查文件长度 | tabWidth: 缩进宽度，默认是4 <br> MaxLineLength: 长度阈值，默认是150 | tabWidth=4 <br> MaxLineLength=150 |
28+
| ObjectiveC/MethodNaming | 检查方法命名格式 | MethodCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 camelBack | MethodCase=camelBack |
29+
| ObjectiveC/ParameterNaming | 检查参数命名格式 | ParameterCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 camelBack | ParameterCase=camelBack |
30+
| CmdInject | 命令行注入漏洞 | 无 | 无 |
31+
| PathTraversal | 路径穿越漏洞 | 无 | 无 |
32+
| SQLInject | SQL注入 | 无 | 无 |
33+
| SSRF | 服务端请求伪造漏洞 | 无 | 无 |
34+
| XSS | 跨站脚本攻击漏洞 | 无 | 无 |

‎doc/zh/guide/代码检查/工具/TCA-Armory-C1.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# TCA-Armory-C1 使用手册
2+
3+
TCA-Armory-C1 属于 TCA 的增强分析模块。
4+
5+
## 功能
6+
- Objective-C/C++ 代码规范
7+
- C/C++/Java 代码安全
8+
9+
## 准备
10+
- 需要事先部署好 [CLS 微服务](https://tencent.github.io/CodeAnalysis/zh/quickStarted/enhanceDeploy.html)
11+
12+
## 规则
13+
| 规则 | 概览 | 参数 | 参数示例 |
14+
| :-------- | :------- | :------- | :------- |
15+
| ObjectiveC/Copyright | 检查代码文件的copyright信息 | 无 | 无 |
16+
| ObjectiveC/Indent | 检查代码文件的缩进 | IndentStyle: 可选 spaces 空格 和 tabs `\t` ，默认是 spaces <br> IndentSize: 缩进长度，默认是4 | IndentStyle=spaces <br> IndentSize=4 |
17+
| ObjectiveC/MaxLinesPerFunction | 检查超出行数长度阈值的函数 | LineThreshold: 方法长度阈值，默认是100 | LineThreshold=100 |
18+
| ObjectiveC/MissingDocInterface | 检查接口需要注释信息 | 无 | 无 |
19+
| ObjectiveC/MissingDocProperty | 检查属性是否有注释 | 无 | 无 |
20+
| ObjectiveC/MissingDocProtocol | 检查protocol是否有注释 | 无 | 无 |
21+
| ObjectiveC/ParameterCount | 检查方法的参数个数 | Max: 参数个数阈值，默认是6 | Max=6 |
22+
| ObjectiveC/ClassNaming | 检查class命名格式 | ClassCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 CamelCase ｜ ClassCase=CamelCase |
23+
| ObjectiveC/FunctionNaming | 检查函数命名格式 | FunctionCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 camelBack | FunctionCase=camelBack |
24+
| ObjectiveC/GlobalVariableNaming | 检查全局变量的命名格式 | GlobalVariablePrefix: 全局变量前缀，默认是`g` <br> GlobalVariableCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 camelBack | GlobalVariablePrefix=g <br> GlobalVariableCase=camelBack |
25+
| ObjectiveC/LocalVariableNaming | 检查局部变量的命名格式 | LocalVariableCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 camelBack | LocalVariableCase=camelBack |
26+
| ObjectiveC/MacroNaming | 检查macro命名格式 | MacroCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 UPPER_CASE | MacroCase=UPPER_CASE |
27+
| ObjectiveC/MaxLineLength | 检查文件长度 | tabWidth: 缩进宽度，默认是4 <br> MaxLineLength: 长度阈值，默认是150 | tabWidth=4 <br> MaxLineLength=150 |
28+
| ObjectiveC/MethodNaming | 检查方法命名格式 | MethodCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 camelBack | MethodCase=camelBack |
29+
| ObjectiveC/ParameterNaming | 检查参数命名格式 | ParameterCase: 命名格式，可选 CamelCase 首字母小写驼峰式、UPPER_CASE 全部大写、LOWER_CASE 全部小写、camelBack 首字母大写驼峰式，默认是 camelBack | ParameterCase=camelBack |
30+
| CmdInject | 命令行注入漏洞 | 无 | 无 |
31+
| PathTraversal | 路径穿越漏洞 | 无 | 无 |
32+
| SQLInject | SQL注入 | 无 | 无 |
33+
| SSRF | 服务端请求伪造漏洞 | 无 | 无 |
34+
| XSS | 跨站脚本攻击漏洞 | 无 | 无 |

0 commit comments

Comments
 (0)