代码段提取
code-snippet的Python项目详细描述
#片段
[![循环](https://circleci.com/gh/armmbed/snippet.svg?style=svg&;circle token=f8151197e9160de7877eda3ae049d0925e9b7ff3)(https://circleci.com/gh/armmbed/snippet)
` snippet`从给定的输入文件集中提取标记的文本部分并保存到其他位置。
例如,
通过从源文件中读取任何编码语言
-使用可自定义的标记语法
-写入模板输出(例如,`.md'代码块)
-隐藏输出中的节
-执行验证以帮助避免代码更改时代码段中断
基本原理
代码文档通常需要一个书面示例演示一些代码的使用。然而,随着项目的发展,这个示例代码很容易过时,甚至包含自己的错误。
一个解决方案是将这些示例编写为可以在所选测试系统中运行的测试。这样可以确保示例的代码始终有效。` snippet`可以用来提取测试的相关信息部分,并将其放入文档系统可以呈现的表单中,提供经过充分测试的代码示例。
《入门入门
<<
<35<35<35<
-`snippet`需要python 3
<35<35<35<
`` `
pip install安装代码段
` `
` ` ` ` ` ` `
pip install安装代码段
pip install安装代码段
` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` lang/toml)
在项目目录中(例如snippet.toml)。可以重写[配置对象](https://github.com/armmbed/snippet/blob/master/src/snippet/config.py l8)中定义的任何值。
基本配置通常包括输入和输出目录:
```
[代码片段]
input_glob='测试/单元/*.py'
output_dir='文档/示例'
````
使用您安装的python解释器snippet to:
```
python-m snippet
````
默认为`*.toml`,可以多次设置。多个文件将按指定的顺序加载并查找。以上次加载的设置为准。
Python -M片断--Auth-MiNy.py[[-V] [-V] [DR] < BR/> BR/>位置参数:
项目根的DIR路径,在加载的任何相对路径中使用[BR/>配置[CWD]
可选参数:
-H,帮助显示此帮助消息并退出
配置配置路径(或globs)配置文件
[![循环](https://circleci.com/gh/armmbed/snippet.svg?style=svg&;circle token=f8151197e9160de7877eda3ae049d0925e9b7ff3)(https://circleci.com/gh/armmbed/snippet)
` snippet`从给定的输入文件集中提取标记的文本部分并保存到其他位置。
例如,
通过从源文件中读取任何编码语言
-使用可自定义的标记语法
-写入模板输出(例如,`.md'代码块)
-隐藏输出中的节
-执行验证以帮助避免代码更改时代码段中断
基本原理
代码文档通常需要一个书面示例演示一些代码的使用。然而,随着项目的发展,这个示例代码很容易过时,甚至包含自己的错误。
一个解决方案是将这些示例编写为可以在所选测试系统中运行的测试。这样可以确保示例的代码始终有效。` snippet`可以用来提取测试的相关信息部分,并将其放入文档系统可以呈现的表单中,提供经过充分测试的代码示例。
《入门入门
<<
<35<35<35<
-`snippet`需要python 3
<35<35<35<
`` `
pip install安装代码段
` `
` ` ` ` ` ` `
pip install安装代码段
pip install安装代码段
` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` lang/toml)
在项目目录中(例如snippet.toml)。可以重写[配置对象](https://github.com/armmbed/snippet/blob/master/src/snippet/config.py l8)中定义的任何值。
基本配置通常包括输入和输出目录:
```
[代码片段]
input_glob='测试/单元/*.py'
output_dir='文档/示例'
````
使用您安装的python解释器snippet to:
```
python-m snippet
````
默认为`*.toml`,可以多次设置。多个文件将按指定的顺序加载并查找。以上次加载的设置为准。
Python -M片断--Auth-MiNy.py[[-V] [-V] [DR] < BR/> BR/>位置参数:
项目根的DIR路径,在加载的任何相对路径中使用[BR/>配置[CWD]
可选参数:
-H,帮助显示此帮助消息并退出
配置配置路径(或globs)配置文件