我已经使用 LaTeX 很长时间了,但我的所有文档文件看起来仍然有点乱。现在我想改掉这个坏习惯,让我的代码变得有条理。
这就是为什么我想知道是否有任何针对 LaTeX 的编码风格指南。不一定是官方的。例如,它可以就如何格式化代码提出建议:
- 在正文/序言中设置注释
- 是否通过一些评论突出显示章节/小节等
- 如何缩进环境
- 如何组织序言以使其更易读
- ETC。
如果(目前)还不存在这样的东西,如果您认为您的代码看起来相当不错,并且能够发布您如何操作的话,那就太好了。
答案1
有一个讲话在 TUG'11 上正是如此:Didier Verna,迈向 LaTeX 编码标准:
这纸仅对 TUG 会员开放,有效期至年底,但视频可供所有人使用。请看:Didier 有很多有趣的想法。您可能还对以下内容感兴趣Chris Rowley 的演讲在 TUG'09。请考虑加入 TUG:这样您可以立即获得 TUGboat 论文和许多其他好处(参见http://tug.org/join.html)
答案2
这就是我会这样做:
一般的
- 缩进三个空格(我发现两个空格不够突出......)
- 用于Tab缩进或用三个空格进行硬编码
使用更多的新行来构造代码,而不是更少,即更喜欢
\newcommand{\mycmd}[1]{% \par\addvspace{\baselineskip}% \noindent My Text:~% \parbox[t]{0.6\textwdith}{% \textbf{#1} }% \par\vspace{\baselineskip}% }
反对
\newcommand{\mycmd}[1]{% \par\addvspace{\baselineskip}\noindent My Text:~\parbox[t]{0.6\textwdith}{\textbf{#1}}% \par\vspace{\baselineskip}% }
这将有助于保留概述并注释掉定义的小片段以查找错误。
前言
每个类选项一行,例如
\documentclass[ ngerman, fontsize=12pt, draft ]{scrartcl}
包之间有空行
缩进属于某个包的所有代码
\usepackage{xy} \xyset{ x=2, y=3 } \renewcommand{\xy}{...}
- 定义之间的空行
- 使用注释来构造代码并说明其作用——这将有助于即使您在一段时间后查看它时也能跟踪您的代码。
身体
缩进环境内容
\begin{xyz} content \end{xyz}
使用注释空白行设置方程式、浮点数和任何其他环境
Some text of a paragraph % \begin{figure} \centering FIGURE \caption{Nice figure} \end{figure} % more text of tis paragraph % \[ y = x^2 \] % last text.
- 在约 70–80 个字符后中断所有行(而不是一直写入直到编辑器中断)。这样可以更轻松地找到 TeX 给出行号的错误。
将 s设置
\footnote
在它们自己的行上并缩进 - 不要忘记注释前一行的末尾以抑制空格。Text with a footnote% \footnote{Text} more text
当某些内容出现多次时,请使用逻辑标记,例如定义宏来格式化名称,而不是使用硬编码
\textsc{Jon Doe}
。这样您就可以在以后非常轻松地进行更改。使用空行来区分标题和常规文本,例如
\chapter{My Chapter} Text \section{My section} Text
答案3
一个简单的策略可以使您的输入主体更具可读性,那就是始终在新行上开始显示材料,并在显示末尾开始另一个新行。在显示数学中换行,以便输入换行与输出中的换行一致。(我刚刚花了几个小时为书“解串”连续输入,我的头都晕了。)
观看 didier verna 演讲的视频的建议非常好。那就这么做吧。