Svn 注释将来可能有用的代码块是一种好的做法吗?

Svn 注释将来可能有用的代码块是一种好的做法吗?,svn,version-control,Svn,Version Control,注释将来可能有用的代码块是一种好的做法吗 我有一段代码,比如我的企业应用程序中的一个Java方法,它可能在不久的将来对我有所帮助 我对这种方法进行了注释,因为目前在我当前的构建中,这种方法没有用处 这里我有一个很好的版本控制系统,也像SVN 那么使用SubVersion或只是注释代码块并在需要时使用它的好做法是什么?我不会注释这段代码,而是删除它 注释代码将有点腐烂,在删除注释并尝试之前,您不会注意到它不再工作 其他开发人员可能会想知道为什么会有您的注释代码。是否对其进行了评论以供测试,但忘记

注释将来可能有用的代码块是一种好的做法吗

  • 我有一段代码,比如我的企业应用程序中的一个Java方法,它可能在不久的将来对我有所帮助
  • 我对这种方法进行了注释,因为目前在我当前的构建中,这种方法没有用处
  • 这里我有一个很好的版本控制系统,也像SVN

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

    我不会注释这段代码,而是删除它

    • 注释代码将有点腐烂,在删除注释并尝试之前,您不会注意到它不再工作
    • 其他开发人员可能会想知道为什么会有您的注释代码。是否对其进行了评论以供测试,但忘记了对其进行联合评论?它应该被移除吗
    • 我会使用Subversion等,你可以提到你删除了这个方法。然后您可以很容易地找到提交并从中获取代码

      • 我不会对这段代码进行注释,而是将其删除

        • 注释代码将有点腐烂,在删除注释并尝试之前,您不会注意到它不再工作
        • 其他开发人员可能会想知道为什么会有您的注释代码。是否对其进行了评论以供测试,但忘记了对其进行联合评论?它应该被移除吗
        • 我会使用Subversion等,你可以提到你删除了这个方法。然后您可以很容易地找到提交并从中获取代码
          • (我认为这个问题最好在程序员页面下讨论)

            老实说,这要视情况而定。如果您知道某段代码很快就会有用,而且将来编写它也不是件小事,那么我认为您没有理由不保留它。然而,关键的一点是,您应该有足够的注释,让其他人知道为什么有一段代码片段被注释掉并留在源代码中

            我的建议是,当有疑问时,不要保留它。只有当你知道你真的应该这样做时,才保留这种代码。

            (我认为这个问题最好在程序员页面下讨论)

            老实说,这要视情况而定。如果您知道某段代码很快就会有用,而且将来编写它也不是件小事,那么我认为您没有理由不保留它。然而,关键的一点是,您应该有足够的注释,让其他人知道为什么有一段代码片段被注释掉并留在源代码中


            我的建议是,当有疑问时,不要保留它。只有当你知道你真的应该这样做的时候,才保留这样的代码。

            注释过的代码有一种趋势,它会持续数月甚至数年而不会被取消注释。它也不经意地出现在搜索中,并可能误导碰巧看到它的其他人

            假设您使用的是一个源代码控制系统和一个bug跟踪器,删除代码并放入一个“任务”或“bug”来重新实现该特性

            我不是开玩笑。移除它。我甚至看到过一些错误,注释踩在注释上,由于嵌套,一些代码没有注释


            最佳实践是依赖subversion、git或其他一些源代码控制系统。注释代码就像在桌子上的每一张纸上贴上一张便条,而不是把它从桌子上拿下来。最后,书桌上堆满了无关紧要的文件。你的源代码太有价值了,不能乱扔一些无关紧要的代码。

            注释过的代码有一种趋势,它会持续数月甚至数年而不会被取消注释。它也不经意地出现在搜索中,并可能误导碰巧看到它的其他人

            假设您使用的是一个源代码控制系统和一个bug跟踪器,删除代码并放入一个“任务”或“bug”来重新实现该特性

            我不是开玩笑。移除它。我甚至看到过一些错误,注释踩在注释上,由于嵌套,一些代码没有注释


            最佳实践是依赖subversion、git或其他一些源代码控制系统。注释代码就像在桌子上的每一张纸上贴上一张便条,而不是把它从桌子上拿下来。最后,书桌上堆满了无关紧要的文件。你的源代码太有价值了,不能乱扔不重要的代码。

            是的。。。我也认为应该在程序员页面中添加这个,但后来因为这个主题而感到困惑。是的。。。我也认为应该在程序员页面中添加此内容,但后来因为主题而感到困惑。@VijaySarin不客气。通常,当这样一个任务启动时,注释周围的代码已经改变了太多,以至于注释掉的块无论如何都不完全正确。如果一开始它是正确的,就不会被评论。@VijaySarin不客气。通常,当这样一个任务启动时,注释周围的代码已经改变了太多,以至于注释掉的块无论如何都不完全正确。如果一开始它是对的,就不会被评论。