注释整个文件

12
有时候,我需要注释整个文件。通常,我会用/* */ 把类包起来,但如果类内已经有现有的注释,那么这种方法就行不通了:
/*
class foo {

    /**
     * Great documentation - but this breaks my 
     * whole-file-comment!
     */
    public void dooFoo() {
    }

}
*/

有没有办法解决这个问题?最好不用在每一行插入//注释。


1
Visual Studio有一个“注释选定行”按钮。 - Brandon Nicoll
1
在Visual Studio中,有一个选项可以将.cs文件的构建操作设置为“无”,这样它就不会被构建(编译)。我不知道Java是否有这个功能。 - Federico Berasategui
我不明白为什么这不适合问答格式? - Zar
2个回答

23
最好不要在每一行都插入 //-注释。
这是最简单的方法。大多数IDE都有快捷键来添加或删除选择区域中每行开头的//,所以你只需要选择整个文件(例如Ctrl-A),然后按下快捷键即可。
Visual Studio:按Ctrl+KCtrl+C进行注释;按Ctrl+KCtrl+U取消注释。
Eclipse和IntelliJ:按Ctrl+/进行切换。
IntelliJ:按Ctrl+Shift+/使用/* ... */,适当处理嵌入的现有注释块。
NetBeans:按Ctrl+Shift+C进行切换。

NetBeans:使用 Ctrl + Shift + C 切换注释。 - MrLore
@MrLore:谢谢,我会添加的 :) - Jon Skeet
@JonSkeet,我该如何像您那样展示这些按钮(在回答中)?它们似乎不是嵌入式图像。 - Abdusalam Ben Haj
@AbZy:这是 <kbd> 标签。 - Jon Skeet
1
Intellij是ctrl-/或ctrl-shift-/用于/* */它足够智能,可以逃脱现有的注释结束语句。 - BevynQ

21

有点晚了,但是好主意。你知道Java有没有类似的东西吗? - Zar

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接