生成ccsjava文档的解析器工具
ccsdoc的Python项目详细描述
CCS命令文档助手
列出可用命令信息，如名称、级别、类型和说明。在
使用
解析
使用命令行工具ccsdoc列出给定文件或目录中的命令。在
- 在一个文件上
在ccsdoc parse --path JavaFile.java - 在一个完整的目录中递归地处理所有.java文件 ^{pr2}$ 在
命令可以输出到CSV文件。在
ccsdoc parse --path JavaFile.java --to javafile_commands.csv
转换
包含命令的CSV表可以使用^{
# e.g. here to Microsoft Word
ccsdoc convert javafile_commands.csv --to docx
示例
工作示例
$ ccsdoc parse --path SimuEPOSController.java SimuEPOSController.java: Command(name=setPosition, type=ACTION, level=ENGINEERING1, desc=For simulator only : Update position with a position given as argument.) Command(name=checkFault, type=QUERY, level=ENGINEERING1, desc=Check if the Controller is in fault.)
缺少参数示例
$ ccsdoc parse --path SimuLoaderStandalonePlutoGateway.java SimuLoaderStandalonePlutoGateway.java: => simulation/SimuLoaderStandalonePlutoGateway.java: issue at line 39: Missing command argument 'description'.
安装
pip install git+https://github.com/aboucaud/command-doc-generator.git
作者
- 项目
标签：
欢迎加入QQ群-->： 979659372
