【问题标题】:How do I turn off '*' in multi-line comments in Eclipse?如何在 Eclipse 中关闭多行注释中的“*”?
【发布时间】:2023-04-04 15:36:01
【问题描述】:

使用Eclipse编码时,如何关闭启动多行注释时出现的“*”cmets?

而不是看到这个,

/**
* Here is a comment
* some more 
*/

我可以得到这个吗?

/**
  Here is a comment
  some more
*/

如果你想知道“/**”是因为我使用了 doxygen。

【问题讨论】:

  • 为了记录,Doxygen 去除了 * 的,所以无论哪种方式都无所谓。

标签: c eclipse eclipse-cdt


【解决方案1】:

正如this thread 中所述,您只能通过转到

来做到这一点(意思是“禁用前导星号”)
 Preferences > Java > Code Style > Code Templates

例如,如果将某个字段的 cmets 的模板修改为:

/**

 */

当您评论一个字段时,它会以这种方式出现(中间没有任何星号)。

但是,它确实违反了 Sun convention for Java comment formatting 直到 jdk1.3(更新:current oracle link)(如 also here 所示)...
然而,正如in the comments Amedee Van Gasse 所述:

从 Javadoc 1.4 开始,the leading asterisks are optional


一种更简单的方法(如果您只需要对代码的某些 cmets 执行此操作,同时使另一个保持标准样式)是,当多行注释出现如下时:

/**
 *
 */

,你可以先去掉前面的星号,输入你的cmets。
您将看到没有其他前导星号出现在每行新 cmets 的开头。

 /**

  */

 /**
    My first line of comment
    My second line of comment
    My third line of comment
  */

【讨论】:

  • 感谢您的回复。我试过了,不幸的是,它不起作用。但是,在相关说明中,我正在编辑的文件是一个 .c 文件。对于每个人的信息,即使没有上述提示,如果我尝试编辑 java 文件,它也不会给我一个前导星号。但是,我需要 C 文件的功能!!!
  • 我已经找了一段时间了。由于我似乎找不到更好的方法,因此我将使用您的第二种方法。 (我会将此标记为已回答)
  • “但是,它确实违反了 Java 注释格式的 Sun 约定(参见此处)...”不正确。它说:“从 Javadoc 1.4 开始,前导星号是可选的。”
  • @AmedeeVanGasse 感谢您的反馈。我已经恢复了那些旧的 java.sun.com 链接,并更新了答案以包含您的评论。
  • 给我之前的评论一些内容:我们的 Java 文件以版权标头开头,带有前导星号。相同的文本位于 MarkDown 文件中,带有 4 个前导空格,以使其成为等宽。通过将版权标头从星号前缀更改为 4 空格前缀,我可以使用 CheckStyle 配置中的 MarkDown 文件来检查文件是否具有适当的版权标头。
【解决方案2】:

在 eclipse 4.2.1 中,我使用了 formatter off / on 功能,请确保不要将 formatter on 标签与 cmets 标签放在同一行,否则星星的噩梦将会回来。

// @formatter:off
/*
Eclipse your * are messing up my comments big time and If I used you
more often I'd put a patch together to add back in the "Add Leading Star" option 
*/
// @formatter:on

必须在 Eclipse 首选项中“打开”开/关功能:Java > Code Style > Formatter。点击“编辑”按钮,“关闭/打开标签”,勾选“启用关闭/打开标签”。

来自

How to turn off the Eclipse code formatter for certain sections of Java code?

还有。我将标签更改为 //off //on 以便于使用

类似的帖子是 How to disable the automatic asterisk (inserting stars) in Eclipse when adding a multi-line comment?

【讨论】:

  • 感谢您的回复。我现在已经转移到其他 IDE,但如果我以后有时间会尝试你的答案。
猜你喜欢
  • 2021-03-14
  • 2015-10-22
  • 2015-12-19
  • 2014-03-10
  • 2010-09-13
  • 2011-01-01
  • 1970-01-01
  • 1970-01-01
  • 2013-10-05
相关资源
最近更新 更多