配置在netbeans中算作javadoc注释的内容
如果文档是完整的,则阻止注释将变得无用,因为单个配置在netbeans中算作javadoc注释的内容,netbeans,Netbeans,如果文档是完整的,则阻止注释将变得无用,因为单个*/是阻止注释的不可穿透的障碍。我被告知doxygen会接受(或者至少可以接受)常规的/注释,但默认情况下netbeans不会 有没有办法将其配置为将所有注释视为Javadoc 例如: /** javadocs*/ class well_documented { /** javadocs*/ Variable A; /** javadocs*/ Variable B; /** javadocs*/ Variabl
*/
是阻止注释的不可穿透的障碍。我被告知doxygen会接受(或者至少可以接受)常规的/
注释,但默认情况下netbeans不会
有没有办法将其配置为将所有注释视为Javadoc
例如:
/** javadocs*/
class well_documented
{
/** javadocs*/
Variable A;
/** javadocs*/
Variable B;
/** javadocs*/
Variable C;
/** javadocs*/
Variable D;
//I want to start the block comment here
/** javadocs*/
void method aa(){}
/** javadocs*/
void method bb(){}
/** javadocs*/
void method cc(){}
/** javadocs*/
void method dd(){}
//and end it here.
}
我这样做是为了替代删除它和担心丢失“撤消历史记录”的做法,以便在重写这些函数时作为一个方便的参考,或者作为一种快速的方法来测试是否使用过这些方法(注释掉,看看它是否抱怨)我现在明白了,您希望的是能够轻松注释掉包含JavaDoc的代码块。对于这两种不同的用例,我推荐两种不同的解决方案,它们都不涉及更改JavaDoc注释样式(这会让其他阅读您代码的人感到困惑):
- 在开发过程中快速(取消)注释代码:IDE应该有一个块注释/取消注释功能,它应该能够处理这样一个事实,即您要注释的部分内容是块注释(在每行的开头使用
,或者将/
转换为变量A;/**javadocs*/Variable B;
-丑陋,但这只是临时的,IDE应该能够将其取消注释回到原始状态)/*变量A;/**javadocs*/*变量B;*/
- 保留供日后参考:请不要这样做!随着时间的推移,您的代码库将积累大量这样的注释掉的代码并变得不可读。正确的解决方案是利用您的源代码管理系统(如果您没有源代码管理系统,请将开始使用源代码管理作为您部门的首要任务):如果它曾经提交过,即使您将其删除,它也将永远保留在您的历史记录中,如果您需要它,它可以重新启动。如果它是来自新的未提交实验的代码,请使用源代码管理系统的隐藏/搁置功能,或者创建一个单独的分支来跟踪它;在那里提交,然后在介绍之前返回我把代码删掉了
//javadocs
而不是块注释/**javadocs*/
,因为我想避免*/
使所有周围的块注释都变得单调乏味……您是否将JavaDoc注释放在常规块注释中?如果不是,havin有什么问题g/*Block comment*/
(新行)/**JavaDoc*/
(新行)/*Block comment*/
?(如果您发布了一个因*//code>而感到乏味的代码示例,这会有所帮助)我更新了我的问题,加入了一个例子。如果我想在我指出的地方开始一条评论并结束评论,我必须至少写8次/*
或*/
,基本上不符合整篇评论的要点。谢谢;这让你的意图更加清晰。请参阅我的更新答案。另外,请阅读前两个答案o,因为我认为您的问题(如何使JavaDoc接受/
)实际上与您的实际问题无关(如何阻止已包含阻止注释的内容的注释,或者如何保持“非活动”代码以备将来参考)。