☰

LaTeX 文档生成器

tag-icon • tag-icon documentation tex-general
LaTeX 文档生成器

有没有文档生成器对于 LaTeXJavadoc对于 Java 或氧自由基对于 C++？

尤其是在整个大型项目中为 LaTeX 文件定义宏或环境时，团队最好能从 LaTeX 文件中的评论自动生成一份不错的文档。

答案1

LaTeX 项目开发了一系列工具来帮助记录 (La)TeX 代码：考虑到 LaTeX 本身是一个庞大而复杂的软件，这并不奇怪。各种“拼图”的组合形成了一种称为.dtx（“记录的 (La)TeX 源”或类似名称）的文件格式。这种格式结合了使用 DocStrip 从源中提取代码的能力和使用该包创建文档的标记工具doc。我已经之前写过关于格式并提供了创建“一体化”的起点.dtx. 最小版本可能看起来像

% \iffalse meta-comment
%<*driver>
\documentclass{ltxdoc}
\begin{document}
  \DocInput{\jobname.dtx}
\end{document}
%</driver>
% \fi
% 
% \section{The documentation}
% 
% \DescribeMacro{\examplemacro}
%   Some text about an example macro called \cs{examplemacro}, which
%   might have an optional argument \oarg{arg1} and mandatory one
%   \marg{arg2}. 
%
% \section{The code}
%
% Start the DocStrip guard for extracting the code.
%    \begin{macrocode}
%<*package>
%    \end{macrocode}
%    
% \begin{macro}{\examplemacro}
%   Something about the implementation here, perhaps.
%    \begin{macrocode}
\newcommand*\examplemacro[2][]{%
  Some code here, probably
}
%    \end{macrocode}
%\end{macro} 
%
%    \begin{macrocode}
%</package>
%    \end{macrocode}

我没有提供.ins从源代码中提取代码所需的文件，只是提供了排版一些注释所需的设置。

LaTeX 软件包作者经常使用此格式，因此 CTAN 上设置的标准有很多变体。

相关内容