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

【文件属性】：

文件名称：XMD:扩展的Markdown用于源代码文档

文件大小：8KB

文件格式：ZIP

更新时间：2024-04-27 23:15:21

Python

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

【文件预览】：
XMD-main
----.gitignore(1KB)
----xmd.py(5KB)
----LICENSE(1KB)
----doc()
--------table.md(26B)
--------xmd.md(828B)
----README.md(2KB)
----xdoc()
--------xmd.xmd(605B)
----test_output.md(262B)
----.gitattributes(66B)
----test()
--------test.sh(30B)
--------src()
--------doc()
--------xdoc()