Delphi 7使用DelphiCodeToDoc生成文档

最新推荐文章于 2012-12-19 14:23:00 发布

原创最新推荐文章于 2012-12-19 14:23:00 发布 · 4k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#delphi #integer #文档 #javadoc #chm #forms

5.2 Delphi编程专栏收录该内容

41 篇文章

订阅专栏

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描述，即是对字段、方法、类、单元等等的说明描述文本，简单格式如下：

{*------------------------------------------------------------------------------ 
   在这里写描述内容 
 -------------------------------------------------------------------------------}  

也可以使用内联注释，这是一种简短的方式来描述，如下格式：

  ///应用程序窗体类 
   Tfrm_Test = class(TForm) 
     btn_Test: TButton;   ///按钮 
     lbl_test: TLabel;    ///文本 

测试使用：
        1.假如我们要为一个应用程序自动生成文档，首先开始新建一个应用程序，保存；
       2.在窗体上放置一个按钮和一个文本，若是有安装CnPack专家包的话，自带的" 代码输入助手"能加快注释的速度，因为它因为添加了JavaDoc格式代码注释列表，如下图所示：

3.完整的代码如下所示：

{*------------------------------------------------------------------------------ 
   这是一个应用程序，演示自动生成文档 
  
   @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. 
  