Hovercouch
2015-12-23 03:23:39 UTC
我正在尋找一種我可以用來在代碼庫上留下註釋而無需更改代碼本身的工具。我認為這樣可以使開發人員更輕鬆地進行討論，例如“嘿@dave，添加FooBar功能後此方法會中斷嗎？”理想情況下，它看起來就像Github如何讓您評論提交和請求，而沒有“它是提交或請求”的限制。以下是我嘗試過的一些事情以及問題所在：
- 在代碼本身中留下註釋：笨拙的閱讀，需要提交，對討論不起作用
- Github評論：很難討論一段時間未更新的代碼，討論僅限於PRs
- 使用聊天室或郵件列表：很難將內容放到上下文中，最好不要將討論放在代碼旁邊
Free是可取的，但比任何東西都更易於使用。 這個問題似乎在問類似的問題，但它似乎是關於合併前代碼審查工具的，而我正在尋找可以對代碼庫中所有代碼進行註釋的東西。謝謝！
gerrit（https://www.gerritcodereview.com/）是否會遇到與GitHub相同的問題？您希望添加到代碼中的註釋的目的是什麼？作為代碼的（永久性）文檔，或者作為代碼版本的討論（即代碼審查），然後對其進行修改，直到成為可接受的下一個版本？
您還可以考慮使用Doxygen，它使您可以將文檔添加到記錄源的單獨文件中。 （http://stackoverflow.com/questions/4075653/alternative-ways-for-adding-doxygen-documentation-to-classes）
我唯一的代碼經驗是使用獨立的文件，這些文件基本上是文本，而在Github等環境中則沒有。有了這一警告，是否可以將代碼“打印”為pdf並註釋pdf滿足您的需求？