我确信这一定是重复的,但我发现的问题并不能完全解决我的问题。
相关问题包括:
我知道.dtx
/.ins
公式是传统方法,但我不想使用需要我重新提取文件的方法.sty
,例如,每次进行更改时都要对其进行测试。我知道我可以使用make
或其他方法自动执行此操作,但时间和麻烦会让我发疯。
[我也看到有人认为这可能不再是最好的选择。例如,有人指出,压缩档案的存在使得将文档与代码包含在同一个文件中的优势降低,或者说注释良好的代码和单独的用户文档是比集成方法更好的选择。]
所以我的问题是如何最好地记录包的代码质代码如果不是使用.dtx
/.ins
方法。请注意,我对记录甚至排版代码几乎一无所知。我曾经使用环境或其他方式排版过非常少的代码verbatim
。
代码是否应该通过注释记录在源文件中?还是应该以某种方式排版?或者......?
根据 David Carlisle 的评论进行编辑,以排除.dtx
/.ins
选项。
答案1
.dtx
暂时不要排除这种方法:)
。有了为这个场合精心制作的 makefile,你.sty
只需要敲几下键盘(和几秒钟)就可以了。我为我的所有 LaTeX 包都使用了这样的 makefile;参见示例这里。
我赞成这种.dtx
方法,因为它让你将文档和代码放在一起。我不记得我在哪里读过/听过它,但注释可以被认为是从未测试过的代码。从未测试过的代码随着时间的推移往往会变得不正确。将文档和它要描述的代码放在一起可以最大限度地降低前者偏离后者的风险。
(总有一天,我发誓我会读 Don Knuth 的文学编程让我的脑子里对这一切更加清晰。)