XMD:扩展的Markdown用于源代码文档 源码

XMD 用于源代码文档的扩展markdown。 XMD允许以语法降价的形式为源代码编写文档。 文档未写在源代码本身中,以确保其不受污染。 为了使文档和源保持同步,脚本会搜索源并检查是否为功能或类(实体)编写了任何文档。 输出为markdown,可以在github存储库页面上进行浏览。 用法 python xmd.py [] [--check-only] 如果未提供repository-path则为当前工作目录. 用来。 --check-only禁用doc目录中的输出markdown文件的生成。 怎么运行的 它以递归方式遍历源目录,并收集所有文件和这些文件中的所有实体。 实体由其签名/声明部分标识。 这些签名需要出现在文档中。 签名不需要是完整的,但是签名的令牌必须以与源中相同的顺序出现。 检测签名 实体通过签名检测,签名要么包含签名关键字之一 源目录