评论/记录项目的最佳实践?

评论/记录项目的最佳实践?

我对 LaTeX 还很陌生,正在处理由其他几个人创建的大型文档。解析起来非常困难(某些部分有索引、格式不一致等)。

添加注释/文档以指导下一个处理文档的人的最佳方法是什么?大多数人使用的标准是什么?我的谷歌搜索被证明是无用的,但完全有可能只是因为我不知道要寻找什么关键词。

答案1

我认为目前没有“官方”的编码指南:请参阅讨论LaTeX 有任何编码风格指南吗?

在我看来,通过包含来自单独文件的章节/部分来构建文档非常有用:

  • 基目录
    • 文件.tex
    • 包括(文件夹)
      • 部分_01.tex
      • 部分_02.tex
      • ...
    • 人物
      • 图 01.png
      • 图02.svg
      • ...

所有贡献者都可以在 includes 文件夹中添加新的章节/节,并在主 document.tex 文件中添加相应的 include 命令。为了更改整个文档的样式或添加自定义命令,您可以在主文件中添加此命令。

我尝试在每个文件的不同部分之间添加注释。将自定义命令与 usepackage 命令或文档信息(如标题等)分开。此外,我建议在每个 usepackage 命令后添加注释,以解释在此处使用它的原因。

我希望这是有帮助的。

相关内容