在用eclipse进行java开发时,经常需要添加一些必要的javadoc注释。可是每当进行Format操作时(亦即按快捷键:Ctrl+Shift+F时),就会对排版进行自作聪明的调整,但往往这种调整是开发者不愿意看到的。
举例如下:
程序员希望的注释格式:
/**
* 根据文件开头的BOM(如果存在的话),判断文件的编码格式。
* 文本文件有各种不同的编码格式,如果判断有误,则会导致显示或保存错误。
* 为了标识文件的编码格式,便于编辑和保存,则在文件开头加入了BOM,用以标识编码格式。
* UTF-8格式:0xef 0xbb 0xbf
* Unicode Little Endian格式:0xff 0xfe
* Unicode Big Endian格式:0xfe 0xff
* 而ANSI格式是没有BOM的。
* 另有一种不含BOM的UTF-8格式的文件,则不易与ANSI相区分,因此未能识别此类格式。
*
* @param file 待判断的文件
*/
执行Format操作后,注释格式却变为:
/**
* 根据文件开头的BOM(如果存在的话),判断文件的编码格式。 文本文件有各种不同的编码格式,如果判断有误,则会导致显示或保存错误。
* 为了标识文件的编码格式,便于编辑和保存,则在文件开头加入了BOM,用以标识编码格式。 UTF-8格式:0xef 0xbb 0xbf, Unicode
* Little Endian格式:0xff 0xfe, Unicode Big Endian格式:0xfe
* 0xff。而ANSI格式是没有BOM的。另有一种不含BOM的UTF-8格式的文件,则不易与ANSI相区分,因此未能识别此类格式。
*
* @param file
* 待判断的文件
*/
以上2种排版格式,哪一个更直观清晰,相信不用多说。
那么如何禁用eclipse对javadoc注释的Format功能呢?其实很简单,操作如下:
依次选择菜单:Window->Preferences...->java->Code Style->Formatter。
如果"Active profile"为默认的profile,则可以选择:New...打开New Profile对话框,输入Profile name为:My-Profile(自定义的名称)
如果"Active profile"为自定义的profile可直接选择Edit...->Comments,去掉"Enable Javadoc comment formatting"的选择->OK。
注:系统默认的profile是不可以直接编辑的,只能新建一个profile,然后才能Edit...。