在c＃中評論

Question

我有一個簡單的問題。我是c＃的新手，我想知道是否將作者放入.cs類。到目前爲止，我已經看到只有摘要和標題註釋放在那裏。

Answer 1

這裏確實沒有正確或錯誤的答案 - 這歸結於公司政策/您的偏好。在我看來，不過，這是不必要的，原因有二：

• 源控制告訴你這些信息
• 不止一個開發者可以在任何一個文件

Answer 2

的發展涉及使用一個源代碼管理系統，把作者作爲評論是完全不相干的。源代碼管理系統可以幫助您將最新更改的人員分配給每一行。

如果您不使用源代碼控制或在網上發佈代碼，評論可能是合適的。

Answer 3

如果代碼庫是共享的，沒有什麼比單個作者更好的了。如果您有任何源代碼管理，它將負責將每個編輯信息與用戶相關聯。這是一個更好的方法，比頂部有作者姓名並在他/她觸摸該文件時附加每個作者姓名。

Answer 4

我會說，如果您要發佈代碼，並且您編寫了代碼，可能有某人的更新，您將您作爲作者，併爲更新/更正/錯誤修復添加備註。

如果它的內部，這不應該是必要的，因爲源代碼控制會照顧到這一點，而在內部它不太重要，試圖說「這是我的」。