LaTeX可用于生产随软件附带的任何文档吗？ [英] Can LaTeX be used for producing any documentation that accompanies software?
问题描述
Although related to this question about LaTeX being used outside mathematics and academia, I'm specifically wondering if anyone uses or is familiar with anyone that uses LaTeX for generating any type of documentation relating to software. If so, could you say whether or not you like LaTeX and the purposes for which you use it? Thanks.
推荐答案
我主要用LaTeX撰写学术论文。然而，我的研究与软件文档有关，所以我实际上处理了一些这些问题。
I mostly write academic papers with LaTeX. However, my research has to do with software documentation, so I actually deal with some of these concerns.
LaTeX最好的是你关心内容和结构，不仅仅是视觉布局。这就像使用CSS而不是纯HTML编写HTML。
The best thing about LaTeX is that you are concerned with content and structure, not just visual layout. This is like writing HTML with CSS rather than pure HTML.
以下是我认为LaTeX有助于创建一些文档的几个原因：
Here are a few reasons that I think LaTeX is useful for creating some documentation:
一个原因是处理多种风格的结构更加结构化，而且风格比视觉更逻辑。例如，如果您正在键入Word，每次想要提到一个类或对象时，您都可以更改样式。在LateX中，我输入的内容如下：
One reason is that dealing with multiple styles is more structured and styles are more "logical" than "visual". For example, if you are typing in Word, every time you want to mention a class or object, you change a style. In LateX, as I type, I write something like:
bla bla bla〜\methodName {foo} bla
bla 〜\className {FooBar}。
bla bla bla~\methodName{foo} bla bla~\className{FooBar}.
我发现对于长文档，这很有用。我可以很容易地找到我的班级名称，改变他们的等等。
I find that for long documents, this is useful. I can easily find my class names, change them, etc.
第二个好处是我可以为实体使用宏。例如，假设我有一些模块处理一些功能，但它的名称可能会更改，或者我不确定它是什么。我可以有一个称为\ModuleForXXX的宏，当我最终选择一个名字或更改它。
A second benefit is that I can use macros for entities. For example, suppose that I have some module that handles some functionality, but that its name may change later or that I'm not sure what it is. I can have a macro called \ModuleForXXX, and when I eventually pick a name or change it.
第三个也许最重要的好处是，从LaTeX中的文件层次结构中创建文档比在Word文档中更容易。我通常有一个主文件，然后包括其他文件，然后包括其他文件等等。我分层次地看（至少在Windows上使用WinEDT），我可以通过改变包含来轻松地重新排列事物的顺序。不用说，我还使用了包含代码摘录和文档文本的实际内容。
A third and perhaps most important benefit is that it is easier to create a document from a hierarchy of files in LaTeX than in a Word document. I typically have a main file that then includes other files, that then include other files and so on. I view it hierarchically (at least on Windows with WinEDT), and I can easily rearrange the order of things just by changing inclusions. Needless to say, I also use includes for the actual content of code excerpts and documentation text.
LaTeX有几个缺点：$ b $ b 1）很少有人知道有些习惯于Word的人只是反感。然而，对于读取最终PDF的人来说，这并不重要。
2）图像放置可能有点棘手，尽管您可以覆盖选项，并强制LaTeX收听您的指示。
3）最好使用双显示器配置。
LaTeX has several drawbacks though: 1) Few people know it and some people who are used to Word just resent it. However, for someone who reads a final PDF, it shouldn't matter. 2) Image placement can be a little tricky, though you can override options and force LaTeX to listen to your instructions. 3) It works best with a dual monitor configuration.
这篇关于LaTeX可用于生产随软件附带的任何文档吗？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！
