使用dtx文档类编写源码
在学习和工作中,需要编写程序,但是注释过多的话会影响速度,特别是对于科研工作而言
是一个很重要的参考!
对于一个脚本语言而言,其方便的地方是编程快速,但是其运行速度不如c
等编译型语言,但是从整体来看,编写python
之类的程序会更加方便。不写注释虽然可以提高运行速度,但是时间久了可能自己都读不懂程序在干什么及当时设计思路都无法回忆起来,更别谈及程序维护了。为了调和注释与可维护的矛盾,决定借用latex
宏包的编写思路,使用dtx
文件编写源码与说明文档二合一的文件,这样可以生成纯粹的无任何注释的脚本程序,同时也可以生成PDF
格式的详细说明文档,不仅可以记录设计思路,还可以详细说明技术细节。
完成第一个 Python
脚本示例,实现了源码与注释的分离,使用 xetex
编译
timecristal.dtx
将获得 timecristal.py
无注释脚本程序,使用 xelatex
编译
timecristal.dtx
将会获得脚本的说明文档,详细的记录了各段代码的作用。