将.proto文件转换成.md接口文档
go run main.go -imp =.proto文件名 -out = .md文件名
参数:-imp 输入的.proto文件名
参数:-out 输出的.md文件名
以上文件,均无须带后缀名, 且支持绝对路径
-
将.proto文件注释规范化
-
打开命令行运行如 以下命令
go run main.go -imp=test/orm -out=test
- 现有版本暂不支持enum
- 不要在message中嵌套message,而应该把结构体参数提取出来,然后调用,例如规范示例.proto中的Uri参数
- //annotation: 是生成文档注释的关键字,应该注意的是,具体规范可参考规范示例.proto:
//xxxxxxx //annotation:xxxxxxxxxxxxxx 不行,关键字前方不能再有注释
// annotation:xxxxxxxxxxxxxx 不行,关键字和//不应该有空格
//annotation:xxxxxxxxxxxxxx 正确!请在结构体的参数后方,或者方法体{}上方使用
V1.0未经大量测试,可能存在不少Bug和不足,欢迎修改意见或新增需求