一個文件的意見

我寫了一個應用程序，其中有很多意見。一個文件的意見

這可能有點不尋常，但是我想知道在Visual Studio中是否有方法將註釋優雅地排列在專用文件中。或者，有沒有辦法在文本文件的某個地方寫文本？

確實，使用註釋很棒，但我的代碼仍然擁塞。

目前我計劃使用一個新的評論類，它只包含註釋，其中包含有關代碼部分的詳細信息。

如果你有更好的主意，非常感謝你分享它。

2017-06-17 JJAA

我的第一個想法是'爲什麼'？爲什麼這麼多的代碼評論？要麼親自解釋它，要麼重寫它，以便更容易理解，並且不再需要它們，或者編寫一個關注解釋部分的手冊/博客帖子。也就是說，也許你應該使用[xml文檔功能]（https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/how-to-use-the-xml-documentation-功能），並有一個文檔工具爲他們生成一個超級花哨的佈局。 –

也許將註釋轉移到功能設計文檔？只有評論代碼不會立即顯示所做的事情。不要深入描述代碼註釋中所做的事情，請在外部文檔中執行此操作。假設一個基礎知識，然後添加缺少的東西。如果你需要超過10-20個單詞，你可能不瞭解正在做什麼，或者代碼太複雜，需要以較小的比特分解。 – imqqmi

好的，謝謝大家，我會考慮你的建議。 – JJAA

我不能強調這是多麼糟糕的主意。

代碼註釋是最好的：作爲代碼的旁邊

它們涉及
簡短
謹慎使用 - 代碼經常變化，註釋會很快出現不一致的現象這一點，然後在你知道它之前，評論會造成更多的傷害而不是好的。

如果真的有一些功能您試圖通過解釋， 爲什麼東西是需要的和它如何它的作品，而不是如何來使用它，我建議寫一個文件來解釋這一點。

有方法可以做到這種種：

共享系統（例如網絡驅動器/共享點）
維基系統上的Word文檔在線/內部（如Atlassian的合流，或GitHub上維基）

（僅舉一對夫婦）

按照其他用戶的建議，但是，你應該確保不會有很多評論，因爲他們強制增加噪音（你清楚發現的東西）。

旁註：我曾經工作過的一家公司，使用意見到處堅持，每個函數必須有其名稱，簽名，誰寫的橫幅評論它，編輯歷史記錄（即使我們使用源控制），並且幾乎每一行代碼都必須進行註釋，以說明它（假定）在做什麼。如果你處於類似的位置，也許試圖解釋這導致的問題？

來源

2017-06-17 22:17:49 Clint

非常感謝，我終於使用了記事本。這個應用程序實際上是一個個人應用程序，但我以一種不尋常的方式爲我寫了它。這就是爲什麼我在代碼的許多部分上評論它們的重要性，作用和用途......這也是因爲我打算稍後分享此應用程序。 – JJAA

一個文件的意見

回答

相關問題