scanner

gofunc

gofunc scanner 从go源码的func comments中提取到指定格式的注解信息和类型信息,生成 mkdoc schema

注解的格式如下:

TODO

arguments:

• enable_go_mod : 是否启用go module
• pkg : 要扫描的包名
• path : 要扫描的路径

pkg的优先级比path更高

docdef

docdef scanner 从json文件直接生成 mkdoc schema

arguments:

• path : 要扫描的根目录
• file_ext : 要扫描拓展名(默认为*.doc.json)