編寫乾淨的 LaTeX 的良好實踐規則?

編寫乾淨的 LaTeX 的良好實踐規則?

是否有編寫乾淨的 LaTeX 的良好實踐規則?類似於 Python 的 PEP8。例子:

  • 空格或製表符(不是巨魔);
  • 換行前有多少列(對於 PEP8 相容的 Python 為 80);
  • 關於評論的一些事情;
  • ETC。

答案1

這裡的簡短回答很簡單:「不,沒有類似 PEP8 或類似的規則」。

對於較長的答案,也許值得將 LaTeX 來源分為兩種類型:

  • 文件(大多數人的大部分工作)
  • 套件和其他“代碼”

當然,存在一些重疊,因為人們可能需要在序言中“快速進行一些編碼”,但原始檔案的“性質”通常大致是一種或另一種情況。

對於文檔,作者的數量曾經看到來源很小:關鍵目標是排版輸出。因此,這實際上取決於所涉及的個人如何提出他們的意見。

對於“代碼”,人們可能會認為結果略有不同,因為至少有可能更廣泛地閱讀/重複使用原始程式碼。然而,實踐經驗表明,大多數軟體包只有一個人實際編寫程式碼,即使對於廣泛使用的材料也是如此。在有例外的情況下,最明顯的是內核,還有諸如beamer或 之類的東西biblatex,「團隊規模」往往很小,通常可以達成非正式協議。 (通常是一個人開始做事情,因此可以在堅持他們所做的事情的基礎上達成某種立場。)當然,在這裡我們可以使用.dtx代碼的格式,這將導致與以下情況截然不同的“評論”結果:來源etoolbox包(例如,將內核與 進行比較)。

有一個代碼風格指南的地方是expl3: 團隊有根據程式碼傾向的方式寫了一個。但即便如此,不遵循這些規則的程式碼也沒有什麼意義是「壞的」:更多的是關於內容

重要的是要記住 TeX 是一種巨集擴展語言,這使得自動「檢查器」難以實現:請參閱 LaTeX 的自動樣式指南?

相關內容