记录源代码 - Microsoft Word

Question

我是一名实习生，有机会为公司设计和配置一个“应用服务器”。它包含各种重要的脚本，作为将其投入生产的过程的一部分，我希望记录所有内容，以便在需要将控制权分配给某人时，让他们了解一切是如何运作的。

我们这里有点守旧，所以我们确实想保留一份 .docx（稍后可能会转换为 .pdf，但我在 Word 中工作）的文档，所以我想问一下有关记录源代码的问题。它大约有 40 页，长话短说，当我将其粘贴到 Word 中时，它看起来真的很丑。

目前我将其粘贴到写字板中，因为它可以保留更简单的文本格式，同时保留缩进和换行符。保存源代码的常用方法是什么？文件本身都已备份，但我还需要纸上的代码。

谢谢。

Answer 1

您需要一个纯文本编辑器来处理源代码和项目文档，而不是文字处理器。Microsoft Word 会使用“智能”引号和其他排版功能来破坏您的代码。

部署和配置确实应该自动化。通过实践来展示：内联注释脚本中棘手的部分，并让其他人检查它们是否清晰。

在单独的设计文档、高级设计和组织环境中关注“为什么”。

将文档提交到管理源代码和脚本的同一版本控制系统。目前可能是 git，但还有其他不错的选择。提交纯文本允许使用与源代码相同的 diff、merge 和冲突检测工具。

有许多标记语言可以将纯文本呈现为屏幕或打印文本。Markdown、wiki、重新结构化文本可能产生漂亮的输出狮身人面像，TeX， 等等。