Linux

記錄原始碼 - Microsoft Word

  • July 9, 2019

我是一名實習生,我有機會為我的公司設計和配置“應用伺服器”。它有各種重要的腳本,作為我將其投入生產過程的一部分,我想記錄所有內容,以便何時需要將控制權分配給某人,以便他們了解一切是如何工作的。

我們在這裡有點過時,所以我們確實想保留文件的 .docx(稍後可能會轉換為 .pdf,但我正在使用 Word),所以我想詢問有關記錄原始碼的問題。它大約有 40~ 頁,長話短說,當我將其粘貼到 word 中時,它看起來真的很難看。

目前我將它粘貼到寫字板中,因為它在保留縮進和換行符的同時保持文本更簡單的格式。保留原始碼的首選方法是什麼?文件本身都已備份,但我還需要紙上的程式碼。

謝謝。

您需要一個用於原始碼和項目文件的純文字編輯器,而不是文字處理器。Microsoft Word 將使用“智能”引號和其他排版功能破壞您的程式碼。

部署和配置一個東西真的應該是自動化的。邊做邊看:內聯註釋腳本中棘手的部分,並讓其他人檢查它們以使其清晰。

在單獨的設計文件、高級設計和組織環境中關注“為什麼”。

將您的文件送出到管理原始碼和腳本的同一版本控制系統。這些天可能是 git,但存在其他不錯的選擇。送出純文字允許使用與原始碼相同的差異、合併和衝突檢測工具。

存在許多可以為螢幕或列印呈現純文字的標記語言。Markdown、wiki、reStructuredText可能帶有SphinxTeX等生成的漂亮輸出。

引用自:https://serverfault.com/questions/974399