☰

何时或为什么应该使用 %% 而不是 %？

tag-icon • tag-icon package-writing documentclass-writing comments
何时或为什么应该使用 %% 而不是 %？

我注意到许多（全部？）样式和类文件都有“文档块”，在行首有一个双注释字符，

%% like so

与通常的评论风格不同，

% like so

为什么要这样做？某些类型的注释是否需要%%进行预处理/自动生成文档等？还是只是习惯？我是否应该将%%和混合%放在同一个文件中以供不同用途？

（具体来说，回答制作自己的 .sty 文件建议使用单注释字符注释，这让我更加困惑。）

答案1

许多类和包都是使用docstrip它会从文件中删除所有常规注释，并且可以将材料合并或拆分到不同的文件中。带有两个百分号的注释称为元字符并且不会被剥离，而是直接写入类或包文件本身。因此，在这些文件中你不会找到整行的单%注释。除此之外，这两种注释之间没有区别。请参阅docstrip和dtxtut手册以了解更多信息。

答案2

%%和之间没有内置的不同行为%；但是由于docstrip从文档化源文件中提取代码的工作方式.dtx，通常序言和最后一行以 开头%%。

当然，可以使用不同标记的线进行预处理，但从纯 TeX 的角度来看，这些线是完全等效的。

我有时发现使用多个%字符来标记文档的特定位置（而不是简单的注释）会更方便，从而更容易地进行搜索；例如，在最终修订中插入用于调整行或分页符的命令，或一般的特殊提醒：

text where something special
%%% Inserted a page break, check the output!
\pagebreak
%%%
has been inserted to get a better page break

因此，可以\pagebreak通过搜索来检查所有特殊事物（可能与 不同） %%%。人们可以根据%忽略以 开头的行这一事实设计出各种标记方案。

相关内容