评论一段可能在将来有用的代码块是一个好习惯吗?

Vij*_*rin 1 svn version-control

评论一段可能在将来有用的代码块是一个好习惯吗?

  1. 我有一段代码在我的企业应用程序中说一个Java方法,这可能会帮助我在近期或远期.
  2. 我正在评论这个方法,因为这在我当前的构建中现在没用.
  3. 在这里,我有一个很好的版本控制系统,如SVN.

那么什么是好的做法 - 使用SubVersion或只是注释代码并在需要时使用它?

Edw*_*uck 5

评论代码具有数月和数年的生存趋势,而不会被取消评论.它也无意中出现在搜索中,并且可能误导其他偶然看一眼的人.

假设您正在使用源代码控制系统和错误跟踪器,请删除代码并输入"任务"或"错误"以重新实现该功能.

我不是在开玩笑.去掉它.我甚至看到过评论踩到评论的错误,并且由于嵌套,一些代码变得没有注释!

最佳实践是依靠subversion或git或其他一些源代码控制系统.评论代码就像在每张纸上贴一张便条,你应该忽略它坐在桌子上(而不是从桌面上取下).最终桌子上的纸张太多了,不重要.您的源代码太宝贵了,无法使用不重要的代码.