片段:从源文件中提取代码片段的Python3工具 源码

片段 总览 从源文件中提取代码段的工具 本质上,代码片段从给定的一组输入文件中提取文本的标记部分,并将其保存在其他位置。 功能包括: 通过从源文件读取,可在任何文本文件上工作,例如,任何编码语言 使用可自定义的标记语法 写入模板输出(例如.md代码块) 隐藏输出中的部分 执行验证以帮​​助避免代码段随代码更改而中断 基本原理 代码文档通常需要一个书面示例来说明某些代码的使用。 但是,随着项目的发展,甚至包含其自身的错误,该示例代码也可能变得很容易过时。 一种解决方案是将示例作为测试编写,可以在所选的测试系统中运行。 这样可以确保示例代码始终有效并且可以正常工作。 然后,可以使用snipp