文件名称：片段：从源文件中提取代码片段的Python3工具
文件大小：74KB
文件格式：ZIP
更新时间：2024-02-26 11:12:59
code documentation-tool project-management snippet documentation-generator
片段 总览 从源文件中提取代码段的工具 本质上，代码片段从给定的一组输入文件中提取文本的标记部分，并将其保存在其他位置。 功能包括： 通过从源文件读取，可在任何文本文件上工作，例如，任何编码语言 使用可自定义的标记语法 写入模板输出（例如.md代码块） 隐藏输出中的部分 执行验证以帮助避免代码段随代码更改而中断 基本原理 代码文档通常需要一个书面示例来说明某些代码的使用。 但是，随着项目的发展，甚至包含其自身的错误，该示例代码也可能变得很容易过时。 一种解决方案是将示例作为测试编写，可以在所选的测试系统中运行。 这样可以确保示例代码始终有效并且可以正常工作。 然后，可以使用snipp
【文件预览】：
snippet-master
----setup.py(2KB)
----.gitignore(341B)
----codecov.yml(577B)
----.codeclimate.yml(649B)
----azure-pipelines()
--------steps()
--------build-release.yml(8KB)
----USAGE.md(4KB)
----pyproject.toml(2KB)
----MANIFEST.in(78B)
----.pre-commit-config.yaml(1022B)
----CONTRIBUTING.md(6KB)
----DEVELOPMENT.md(4KB)
----CODE_OF_CONDUCT.md(5KB)
----LICENSE(10KB)
----CHANGELOG.md(1000B)
----setup.cfg(1KB)
----snippet()
--------__init__.py(235B)
--------cli.py(2KB)
--------_internal()
--------api.py(682B)
--------snippet.py(6KB)
--------config.py(4KB)
--------__main__.py(174B)
--------_version.py(387B)
--------workflow.py(3KB)
--------exceptions.py(606B)
----.github()
--------PULL_REQUEST_TEMPLATE.md(487B)
--------ISSUE_TEMPLATE.md(541B)
----README.md(7KB)
----tests()
--------__init__.py(301B)
--------test_config.py(3KB)
--------samples()
--------test_direct.py(1KB)
--------test_true.py(257B)
--------test_parser.py(6KB)
--------test_support.py(1KB)
--------test_workflow.py(2KB)
----Pipfile(408B)
----news()
--------README.md(279B)
----KNOWN_ISSUES.md(93B)
----.gitattributes(12B)
----docs()
--------workflow.html(10KB)
--------cli.html(9KB)
--------config.html(21KB)
--------third_party_IP_report.html(4KB)
--------snippet.html(35KB)
--------third_party_IP_report.csv(519B)
--------api.html(8KB)
--------third_party_IP_report.txt(1KB)
--------exceptions.html(12KB)
--------index.html(8KB)