编写干净的 LaTeX 的良好实践规则?

编写干净的 LaTeX 的良好实践规则?

编写干净的 LaTeX 是否有好的实践规则?比如 Python 的 PEP8。示例:

  • 空格或制表符(不是巨魔);
  • 换行前有多少列(对于符合 PEP8 规范的 Python 来说为 80 列);
  • 关于评论的一些内容;
  • ETC。

答案1

这里的简短回答很简单:“不,没有类似于 PEP8 或类似的规则”。

为了得到更长的答案,也许值得将 LaTeX 源分为两种类型:

  • 文档(大多数人的主要工作)
  • 软件包和其他“代码”

当然,存在一些重叠,因为可能需要在序言中“快速进行一些编码”,但源文件的“性质”通常大致是其中一种情况。

对于文档,将曾经源码很小:关键目标是排版输出。因此,如何布局输入实际上取决于参与的个人。

对于“代码”,人们可能会争论结果略有不同,因为至少存在更广泛阅读/重用源代码的潜力。然而,实践经验表明,大多数软件包只有一个人实际编写代码,即使是广泛使用的材料也是如此。也有例外,最明显的是内核,但也包括或之类的东西beamerbiblatex“团队规模”往往很小,通常可以达成非正式协议。(通常一个人已经开始做事,因此可以基于坚持他们所做的任何事情达成某种立场。)当然,在这里我们可能会使用.dtx代码的格式,这会导致与源代码的情况非常不同的“评论”结果软件包(etoolbox例如,将内核与 进行对比)。

代码风格指南的其中一个地方是expl3:团队有根据代码的倾向编写一个。尽管如此,不遵循这些规则的代码也并不意味着“不好”:更多的是关于内容

重要的是要记住,TeX 是一种宏扩展语言,这使得自动“检查器”难以实现:参见 LaTeX 的自动样式指南?

相关内容