DelphiCodeToDoc是一个免费的Delphi文档系统,在GNU通用公共许可证下发布。它使用文件中有关源代码符号和格式化注释的信息,来为你的应用程序和组件生成准确的文档。
从 http://sourceforge.net/projects/dephicodetodoc/files/下载已编译好的可执行程序" DelphiCodeToDoc_exe_v0.23b.zip",若是要自己编译,需要高版本的Delphi(如:Delphi 2009)和JCL&JVCL库。下载完成后,解压到文件夹,运行"DelphiCodeToDoc.exe"程序,可以设置简体中文语言,界面如下所示:
支持的标签列表:
*Description (没有 '@' 标签!)
*@author
*@version
*@param
*@return
*@throws
*@todo
*@Comment (and special inline extended comment)
*@see (Not functionnal for the moment in DelphiCodeToDoc)
对于Description描述,即是对字段、方法、类、单元等等的说明描述文本,简单格式如下:
也可以使用内联注释,这是一种简短的方式来描述,如下格式:
测试使用:
1.假如我们要为一个应用程序自动生成文档,首先开始新建一个应用程序,保存;
2.在窗体上放置一个按钮和一个文本,若是有安装CnPack专家包的话,自带的" 代码输入助手"能加快注释的速度,因为它因为添加了JavaDoc格式代码注释列表,如下图所示:
3.完整的代码如下所示:
4.运行"DelphiCodeToDoc.exe"程序,菜单"文件"→"
新建完全向导项目"→"下一步",填写项目名称、作者等等,如下图所示:
5.接着"下一步",选择工程文件,再点击添加按钮。如下图所示:
6.接着"下一步",到"输出格式"页面,选择"输出格式"为" CHM"。再"下一步",去掉" 标签为空警告"。然后"下一步"到完成;
7.点击菜单"项目"→" 检查和构建",等待生成文件,自动弹出CHM文件,如下图所示:
从 http://sourceforge.net/projects/dephicodetodoc/files/下载已编译好的可执行程序" DelphiCodeToDoc_exe_v0.23b.zip",若是要自己编译,需要高版本的Delphi(如:Delphi 2009)和JCL&JVCL库。下载完成后,解压到文件夹,运行"DelphiCodeToDoc.exe"程序,可以设置简体中文语言,界面如下所示:
![](http://hi.csdn.net/attachment/201109/28/0_13171938755au6.gif)
支持的标签列表:
*Description (没有 '@' 标签!)
*@author
*@version
*@param
*@return
*@throws
*@todo
*@Comment (and special inline extended comment)
*@see (Not functionnal for the moment in DelphiCodeToDoc)
对于Description描述,即是对字段、方法、类、单元等等的说明描述文本,简单格式如下:
{*------------------------------------------------------------------------------ 在这里写描述内容 -------------------------------------------------------------------------------} |
///应用程序窗体类 Tfrm_Test = class(TForm) btn_Test: TButton; ///按钮 lbl_test: TLabel; ///文本 |
测试使用:
1.假如我们要为一个应用程序自动生成文档,首先开始新建一个应用程序,保存;
2.在窗体上放置一个按钮和一个文本,若是有安装CnPack专家包的话,自带的" 代码输入助手"能加快注释的速度,因为它因为添加了JavaDoc格式代码注释列表,如下图所示:
![](http://hi.csdn.net/attachment/201109/28/0_13171940322tbB.gif)
3.完整的代码如下所示:
01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
| {*------------------------------------------------------------------------------ 这是一个应用程序,演示自动生成文档 @author Administrator @version 2011/09/28 1.0 Initial revision. @todo @comment 这是注释标签 -------------------------------------------------------------------------------} unit Unit1; interface uses Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms, Dialogs, StdCtrls; type ///应用程序窗体类 Tfrm_Test = class(TForm) btn_Test: TButton; ///按钮 lbl_test: TLabel; ///文本 procedure FormCreate(Sender: TObject); procedure FormDestroy(Sender: TObject); procedure btn_TestClick(Sender: TObject); private function AddSome(AOne, AOther: Integer): Integer; public { Public declarations } end; var frm_Test: Tfrm_Test; ///窗体对象 implementation {$R *.dfm} {*------------------------------------------------------------------------------ 窗体创建函数 @param Sender 触发事件的对象 -------------------------------------------------------------------------------} procedure Tfrm_Test.FormCreate(Sender: TObject); begin // end; {*------------------------------------------------------------------------------ 窗体销毁函数 @param Sender 触发事件的对象 -------------------------------------------------------------------------------} procedure Tfrm_Test.FormDestroy(Sender: TObject); begin // end; {*------------------------------------------------------------------------------ 按钮点击事件 @param Sender 触发事件的对象 -------------------------------------------------------------------------------} procedure Tfrm_Test.btn_TestClick(Sender: TObject); begin ///调用计算 AddSome(1, 2); end; {*------------------------------------------------------------------------------ 两数相加 @param AOne 第一个数 @param AOther 第二个数 @return 相加之和 -------------------------------------------------------------------------------} function Tfrm_Test.AddSome(AOne, AOther: Integer): Integer; begin Result := AOne + AOther; end; end. |
![](http://hi.csdn.net/attachment/201109/28/0_1317194373KfIT.gif)
5.接着"下一步",选择工程文件,再点击添加按钮。如下图所示:
![](http://hi.csdn.net/attachment/201109/28/0_1317194389LL0f.gif)
6.接着"下一步",到"输出格式"页面,选择"输出格式"为" CHM"。再"下一步",去掉" 标签为空警告"。然后"下一步"到完成;
7.点击菜单"项目"→" 检查和构建",等待生成文件,自动弹出CHM文件,如下图所示:
![](http://hi.csdn.net/attachment/201109/28/0_13171944013gg3.gif)
![](http://hi.csdn.net/attachment/201109/28/0_1317194868f703.gif)