Eclipse Docs风格评论Eclipse?

时间:2014-05-13 15:49:45

标签: comments eclipse plugins

编辑Google文档文档时,可以添加可在侧栏中查看的文本注释块。选择注释会突出显示相应的文本块,反之亦然,这样我就可以清楚地看到哪个注释对哪个块有意义。添加这些注释似乎不会对文档本身进行任何更改。

我的团队和我必须处理许多不一致且难以导航的遗留代码。我们主要使用Eclipse。

我希望在Eclipse中具有类似的功能,以及导出和导入这些注释的功能。似乎有“书签”和“任务”功能,但它们没有突出显示代码。

这些功能是否适用于Eclipse?

1 个答案:

答案 0 :(得分:0)

我认为您应该将这些评论放在源代码中。如果需要它们来理解代码,您希望尽可能使它们可访问。与Google文档(或Office文档,或PDF或......)不同,源文件是原始文本文件,除非您使用可能使事情变得混乱的外部文件,否则无法将这些注释嵌入其中。另外,我总是反对仅允许使用具有特定IDE配置的项目的解决方案......

如果您仍想使用外部评论...

外部注释代码块经常在代码审查中完成,所以我会研究Eclipse的代码审查插件。最受欢迎的似乎是AgileReview。它会将您的审核数据保存在AgileReview Source Project XML文件中 - 这样可以解答您导出和导入这些评论的能力"要求。

此选项的缺点是,现在您的评论比源代码更难访问。源代码是纯文本文件,可以使用任何IDE或文本编辑器读取,而注释只能通过安装了AgileReview插件的Eclipse读取(除非您想直接处理注释XML文件)。您已经说过,您的大多数团队都使用Eclipse,因此这只会导致使用其他东西的人遇到问题,或者当您只想打开源文件来查看某些代码而无需等待Eclipse加载时

另一种选择是将Review BoardeReviewBoard plugin(或类似软件)一起使用。我非常怀疑Eclipse界面和第一个插件一样好(我没试过,eReviewBoard没有像AgileReview这样的花哨网站) - 评论板是这里的主要产品,而不是Eclipse插件,因此,您希望通过Review Board网络应用程序进行许多管理。这意味着您必须设置一个可以同步所有人的Review Board服务器。

这种方法的主要缺点(除了必须设置审查委员会服务器,这不应该那么难)是你只能审查已经提交给SCM的东西(AFAIK - 我没试过它,我只是假设情况就是如此,因为审查委员会从SCM获取源代码以进行审查......)。这对您来说不应该是一个很大的问题,因为您主要想要评论已经在SCM中的遗留代码。