从源代码注释生成样板。
txt2boil的Python项目详细描述
这是一个样板生成器,它基于 它在源代码中找到的注释。
动机
其动机是普通的样板生成器要么需要 你要破解你正在使用的构建系统(在其上构建源代码 或者静态生成锅炉板(然后 如果不将 第一个生成它的脚本)。
它最初的用途是在 用racket编程语言完成的家庭作业。所以 为rational number数据类型编写测试代码的示例:
;; Constant Gen: r([0-9]+)/([0-9]+) (make-rational \1 \2) (check-expect (rational-add r7/9 r5/6) r29/18)
会变成:
;; Constant Gen: r([0-9]+)/([0-9]+) (make-rational \1 \2) (define r29/18 (make-rational 29 18)) (define r5/6 (make-rational 5 6)) (define r7/9 (make-rational 7 9)) (check-expect (rational-add r7/9 r5/6) r29/18)
不管你在源文件上运行了多少次程序, 它将只生成相同的输出,或者添加/删除样板文件 根据源文件的变化。
有了这个,就可以将样板保存在VCS中,并使用txt2boil来 需要时随时更新。
安装
安装的首选方法是使用pip:
pip install txt2boil
尽管你不是一个普通的pip用户或者不习惯使用pip 另一种选择是下载带有git:
的存储库git clone https://github.com/kcolford/txt2boil.git cd txt2boil
或者您可以通过clicking here从pypi网站下载tar包,然后单击 绿色的下载图标。或者您可以使用wget(或 curl如果您愿意的话:
wget https://pypi.python.org/packages/source/t/txt2boil/txt2boil-x.x.x.tar.gz
一旦你有了tar球,把它解包并转到目录 包含它:
tar xf txt2boil-x.x.x.tar.gz cd txt2boil-x.x.x
一旦你进入了源代码库(不管你是怎么得到的) 运行setup.py脚本:
python setup.py install
如何使用
要像上面的示例那样使用txt2boil,只需使用:
txt2boil -i rational.rkt
-i选项指定就地更新文件,而不是 在标准输出端输出。
支持的语言
语言支持完全取决于包的核心语言 库具有的功能。当前的语言是 支持的是:
- C
- Java
- Python
- 球拍
网络状态
txt2boil有两个重要的web资源。首先是 源存储库,第二个是pypi页面。不管 你去哪一家,这份文件应该是找到的主页 在那里。
在pypi(python 包索引)页可以找到here。
虽然git集线器存储库只有源代码,但pypi页面有 下载二进制发行版。这些二进制分布是 由任何慷慨的人提供,把他们的电脑借给这项工作 编译并上传它们。任何有权 上传到pypi只需要运行shell脚本upload.sh或批处理脚本upload.bat。
许可证
版权所有(c)2014 Kieran Colford
此文件是txt2boil的一部分。
txt2boil是免费软件:您可以重新发布和/或修改它 根据 自由软件基金会,或者许可证的第3版,或者 选项)任何更高版本。
Txt2Boil的目的是希望它能有用,但是 没有任何保证;甚至没有 适销性或适合某一特定目的的适销性。看GNU 一般公共许可证了解更多详细信息。
你应该收到GNU通用公共许可证的副本 以及TXT2机油。如果没有,请参见<;http://www.gnu.org/licenses/>;。