配置netbeans中的javadoc注释

时间:2015-07-07 04:36:58

标签: netbeans

如果文档是彻底的,则块注释将变得无用,因为单个time是阻止注释的难以逾越的障碍。我被告知doxygen接受(或至少可以接受)常规*/评论,但默认情况下netbeans不会。

有没有办法将其配置为将所有注释视为javadoc?

例如:

//

我会这样做,作为删除它的替代方案,并担心失去我的“撤消历史记录”,在我重写这些功能时保持作为一个方便的参考,或者只是作为测试这些方法是否永远的快速方法使用(注释掉,看看是否有抱怨)

1 个答案:

答案 0 :(得分:0)

我现在明白,您希望能够轻松地注释掉包含JavaDoc的代码块。对于您的两个不同用例,我建议使用两种不同的解决方案,这两种解决方案都不涉及更改JavaDoc注释样式(这会使读取代码的其他人感到困惑):

  • 在开发过程中快速(取消)注释代码:您的IDE应该具有块注释/取消注释功能,该功能应该能够处理您注释掉的部分内容是块注释(通过使用{ {1}}在每一行的开头,或将//转换为Variable A; /** javadocs */ Variable B; - 丑陋,但它只是暂时的,IDE应该能够将其取消注释回原始版本状态)。
  • 保留供以后参考:请不要这样做!随着时间的推移,您的代码库将累积大量此类已注释掉的代码并变得不可读。这里正确的解决方案是利用您的源代码管理系统(如果您没有,使其成为您部门的首要任务,开始使用源代码管理):它曾经被承诺过,即使你删除它也会永远留在你的历史中,如果你需要的话它可以恢复。如果它是来自新的未提交实验的代码,请使用源控制系统的存储/搁置功能,或创建一个单独的分支来跟踪它;在那里提交,然后在介绍代码之前再回过头来。