禁用部分javadoc的Eclipse代码格式

Question

我有一个Java类,其中javadoc的一部分实际上是作为构建过程的一部分生成的:方法的返回值(静态字符串值)被插入到源文件中,就像$Revision: $标签在某些版本控制软件中工作一样.

虽然这种行为可能有问题,但我使用的框架(WEKA机器学习库)需要这种信息重复.我希望Eclipse的代码格式化程序不要干扰生成的注释.我正在使用Eclipse Indigo版本.

我可以用特殊的注释开启/格式化关闭//@formatter:on和//@formatter:off.但是,@formatter标签仅在"正常"注释中起作用,而不在javadoc注释中起作用.显然,它们很容易与javadoc标签混淆.这意味着我无法关闭javadoc注释的生成部分的格式化程序(例如,自动换行),并将其保留为其余部分,因为@formatter指令必须放在javadoc注释周围.

有一个解决方法来切换javadoc注释中的代码格式？

Answer 1

有一段时间以来,这被问及/回答并帮助我改进了以下答案,希望另外有用.我使用这个替代方案,因为我想在Javadocs中运行Javascript.

Eclipse提供了@formatter:off和@formatter:需要通过Windows-> Preferences-> java-> code style-> formatter ::: edit button ::: tab"off/on tags"启用.它们可用于任何评论.

围绕博士的东西

// @formatter:off
/**
* javadoc
*/ 
// @formatter:on

但是当您希望在javadoc中关闭格式化程序时,请在html注释中使用@formatter:xxx <!-- xxxxx -->来指示您要执行的操作.使用<code>...</code>bloack确保没有格式化并将代码包含为javascript.

编辑了示例中的代码语句,因为我希望这可以在eclipse和netbeans上工作.我找到了格式化程序:关闭工作,但后来停止了不同版本的eclipse(是的,我使用多个IDE版本).

/** 
* <br><!-- @formatter:off -->
* <code>
* <script type="text/javascript">
* // hash structure for holding variable as name and its text
* var hashText = {};
*  
* // function causes a hyper-link to be created
* function insertLink(varName, text){
*    var link22;
*  
*    hashText[varName] = text;
*  
*    link22 = '<a href="./ConsoleCapture.html#' + varName + '">' + hashText[varName] + '</a>';
*       
*    document.write(link22);
* }
* function insertLinkA(varName){
*    var link22;
*
*    link22 = '<a href="./ConsoleCapture.html#' + varName + '">' + hashText[varName] + '</a>';
*
*    document.write(link22);
* }
*      
* function setLinkPoint(varName, text){
*     hashText[varName] = text;
*      
*     document.write('<a id="' + varName + '"><U>' + hashText[varName] + '</U></a>');
* }
*      
* function setLinkPointA(varName){
*    document.write('<a id="' + varName + '"><U>' + hashText[varName] + '</U></a>');
* }
* </script>
* <code>
* <!-- @formatter:on -->
*
*
*/

Answer 2

您可以禁用标题的格式，但我不相信您可以有选择地禁用非标题 javadoc 注释的格式。