我必须在Framemaker中编写一份技术文档，解释各种编程源代码。
所以我的文档由一堆文本组成，后跟一堆源代码（Java，XML），然后是更多文本等。
这个问题与我是否应该使用Framemaker无关 - 这是我必须使用的软件。 。 。
我很困惑的是如何将源代码格式化为我的文档的一部分。有没有人为技术文档做过这个并且遇到任何说明或提示？到目前为止，我的谷歌搜索还没有产生任何与我需要做的事情有关的事情。
答案 0 :(得分：2)
至少，为代码示例创建一个段落样式，使用一个好的等宽字体，并且不要忘记关闭连字符。
当我以前这样做时，我会创建一个表格样式并将代码粘贴在那里，所以我上面有一个很好的标题标题，它突出了一点。唯一的问题是Frame表格单元格不会突破分页符，因此如果您的代码比页面长或者威胁要低于页面底部，则需要在表格中创建多行并且分解行中的代码。
答案 1 :(得分：0)
几年前我写的一篇论文将于下周在网上再次发布。
排版人员主要关注易读性，并拥有工具，实践和传统 可以追溯到几百年甚至几千年，在设置文本时可以依赖它 自然语言。但是，计算机程序不是用自然语言编写的。他们 用“编程语言”编写：人工语言，它们有自己的规则 语法，他们自己的表达惯例，以及他们自己的易读性标准。电脑 因此，代码是排版的特殊领域，就像音乐，数学和化学一样。 这些域有自己的规则，这些规则不是设置自然时使用的规则 语言。
计算机编程本身是最近的起源，而且 将其设置为类型的做法不会超过大约45年：大量的 计算机代码仅在过去20年或更短时间内发布。相关的印刷术 纪律是不成熟的或实际上根本不存在，而且是印刷的 通过检查许多贸易书籍，您可以看到对该领域从业者的期望也很低。没有理由不尝试做得更好。
使用无衬线字体。在我的一本书中，我使用了相同的字体系列，FF Scala用于文本，FF Scala Sans用于代码。我认为它看起来很棒，但有相反的意见：这些可能会迫使你使用等宽字体，虽然我个人认为这已经过时了。避免使用Courier，它不会与任何东西混合。
缩进是符号的一部分。您必须尊重现有的左缩进。源代码已经被选中。将每个标签最多减少到一个或两个空格，否则您将耗尽水平空间。
尝试尽可能多地丢失垂直空间，例如：抑制空白行。尝试将整个样本放到一个页面上。如果有必要，让它浮动。
换行符是符号的一部分。不咨询作者，不要添加换行符。
引号是表示法的一部分。不要将单身改为双人，反之亦然。
理由：计算机程序总是被写入，查看和设置为左对齐，右对齐。
分页符。在书中设置计算机代码时，分页符不能仅遵循排版自然语言时使用的简单孤立/寡妇原则。相反，如果可能的话，代码的逻辑“块”必须保持在一起。印刷工人通常不可能这样做 确定代码中的块边界，尽管空白行通常是可接受的 分页点。应使用以下代码块保留“阻止注释”。 如果您不知道这些是什么，请询问作者。
断字。编程语言不是自然语言，并且不遵守通常的连字约定。如果您需要连字符，请咨询作者，或者只是不要。除非按照作者的指示，否则程序文本中的单词不得用连字符或换行符。
大小写。程序代码中的案例通常对计算机很重要，实际上总是对作者及其读者有意义。通常使用成对的单词，它们仅在不同的情况下有所不同，代表不同的东西：例如BufferedOutputStream和bufferedOutputStream。 程序员，尤其是作者程序员，通常都是高度系统化的 案例，对于印刷师（或其他程序员）来说可能不一定有意义。
实用建议