程式碼文檔和使用者文檔之間的區別

程式碼文檔和使用者文檔之間的區別

如何打包你的 LaTeX 包教學:

“包的重要部分是程式碼、程式碼文件和使用者文件。”

程式碼文檔和使用者文檔有什麼區別?

答案1

好吧,儘管 jjdb 恰到好處:

使用者文件 = 使用者指南,程式碼文件 = 程式設計師指南

我會嘗試更詩意一點:

使用者指南,顧名思義,是供使用者使用的,即坐在電腦後面並使用您的程式碼來做他需要做的任何事情的人。

文件程式碼是程式設計師遵循的良好實踐的一部分,以便追蹤他正在做的事情,為任何想要接觸程式碼的人留下清晰的資訊並保持頭腦清醒(特別是當從長時間的工作中回來時)不與程式碼互動)。

基本上,用戶文檔應該盡可能說明性,因為您不知道閱讀它的人對包的理解程度如何(請記住,如果這是第一個版本,很可能沒有人見過之前),而程式碼文檔應該旨在演示您的程式碼正在做什麼以及在哪裡執行,因此可以盡可能輕鬆地進行任何修改。

相關內容