`
sinpool
  • 浏览: 14628 次
  • 性别: Icon_minigender_1
  • 来自: /home
最近访客 更多访客>>
社区版块
存档分类
最新评论

为D源代码生成文档的candydoc命令

阅读更多

 

背景:

使用CandyDoc生成文档时,
需要手动修改一些文件,
尤其是要在modules.docc中列出所有的模块,
以便在文档中提供导航的功能。


为了方便文档的生成,
有了做一个自动生成文档命令的想法,
不知道是否已经有结合CandyDoc自动生成文档的方法了,
就当是学习D语言一周的一个练习吧。

如果哪位朋友也需要这个工具(candydoc.exe),
请随便下载后使用。

 

主要思想:
把使用CandyDoc时那些需要手动修改的内容让candydoc.exe去做,
只需要简单地输入“candydoc -src=srcpath”就可以完成文档的生成了。


解压缩下载包之后,
目录结构是这样:

写道
-----文件夹
    |--candydoc.exe
       |--docs 
          |--candydoc 
              |--img(d) 
              |--candy.ddoc(f) 
              |--explorer.js(f) 
              |--ie56hack.css(f) 
              |--modules.ddoc(f) 
              |--style.css(f) 
              |--tree.js(f) 
              |--util.js(f)

 

生成文档以后的目录结构:

写道
-----文件夹
     |--candydoc.exe 
         |--docs 
            |--candydoc 
               |--img(d) 
               |--candy.ddoc(f) 
               |--explorer.js(f) 
               |--ie56hack.css(f) 
               |--modules.ddoc(f) 
               |--style.css(f) 
               |--tree.js(f) 
               |--util.js(f) 
            |--foo.html 
            |--bar.html

 

使用方法:

写道
Usage:
  candydoc -src=srcpath {-switch} 

  -src=srcpath 指定D源代码的顶级目录(Require) 
  -Dd=docspath 指定文档输出目录, 默认:[.\docs] 
  -candy=candyfile 指定candy.ddoc, 默认:[.\docs\candydoc\candy.ddoc] 
  -module=modulesfile 指定modules.ddoc, 默认:[.\docs\candydoc\modules.ddoc] 
  --help 显示帮助信息 

  建议: 将candydoc.exe和docs目录放在同一个文件夹中, 
          然后,运行candydoc命令, 
          生成的文档(html)将出现在docs目录中。 
  注意: 确保docs目录中存在candydoc文件夹,否则,生成的文档将没有theme。 
  例子: 【1】candydoc -src=D:\dmd_project\projectA\src 
            对-src指定的源代码中的注释,在当前目录docs中生成文档。 
  例子: 【2】candydoc -src=..\..\src -Dd=..\docs 
            对-src指定的源代码中的注释,在上级目录的docs中生成文档。

 

实战:

假设使用下面的D源代码:

module candydocsample;

/**
*CandyDoc例子
*Authors:Sinpool
*Date:2011-05-21 
*/
class CandyDocSample{
	
	/**
	*KEY(Code1)
	*/
	public static const string KEY_CODE1 = "key_code1";
	
	/**
	*KEY(Code2)
	*/
	public static const string KEY_CODE2 = "key_code2";
	
	/**
	*默认的构造函数。
	*/
	this(){
		//……
	}
	
	/**
	*获得文件ID。
	*Returns:
	*	返回文件ID
	*/
	public int getFileId(){
		//……
		return 0;
	}
	
	/**
	*设置文件ID。
	*Params:
	*	x_fileId = 文件ID
	*Examples:
	*	setFileId(10010)
	*/
	public void setFileId(int x_fileId){
		//……
	}
	
	/**
	*设置文件ID。
	*Params:
	*	x_fileId = 文件ID
	*Examples:
	*	setFileId("10010")
	*Deprecated:
	*	已经废弃,请使用setFileId(int x_fileId)
	*/
	public void setFileId(string x_fileId){
		//……
	}
}

 

 

生成的docs像下面这样:

结果

 下载:

 

     点击这里下载。

  • 大小: 70.7 KB
分享到:
评论

相关推荐

    源代码、技术文档管理制度

    ### 源代码与技术文档管理制度 #### 一、总则 - **目的**: 为了保障公司的源代码和开发文档的安全性,确保源代码的完整性,制定了本管理办法。 - **适用范围**: 本办法适用于所有接触源代码的部门和个人。 - **管理...

    Java开发案例-springboot-53-导出数据库表信息生成Word文档-源代码+文档.rar

    Java开发案例-springboot-53-导出数据库表信息生成Word文档-源代码+文档.rar Java开发案例-springboot-53-导出数据库表信息生成Word文档-源代码+文档.rar Java开发案例-springboot-53-导出数据库表信息生成Word文档-...

    源代码及文档管理制度

    同时,为帮助员工更好地理解和执行规定,制度提供了《源代码及文档管理操作指南》和《SVN客户端用户手册》,这些文档成为了员工在实际操作中的实用工具。 综合来看,该源代码及文档管理制度构建了一个全面且严谨的...

    软著申请60页的源代码文档生成工具 2.0

    该软件能帮助程序员将代码直接整理组织成申请软件著作权所需的源代码文档,本文件生成全部代码文档(备查),60页代码(前后各30页)提交申请用,文档格式为PDF版,需要付费注册,未注册的会在文档有“未注册”的...

    【最新版】Doxygen-1.8.18.dmg【亲测可用】最好的从源代码生成文档

    该文档是直接从源代码中提取的,这使得使文档与源代码保持一致变得容易得多。 您可以配置 doxygen从未记录的源文件中提取代码结构。这对于在大型源代码发行版中快速找到您的方式非常有用。Doxygen还可以通过包括依赖...

    基于强化学习方法 DQN 生成基于机器学习的恶意流量检测模型源代码+文档说明

    基于强化学习方法 DQN 生成基于机器学习的恶意流量检测模型源代码+文档说明,含有代码注释,新手也可看懂,个人手打98分项目,导师非常认可的高分项目,毕业设计、期末大作业和课程设计高分必看,下载下来,简单部署...

    JavaDoc生成API文档(powernode document)(源代码和导出的文档)

    JavaDoc生成API文档(powernode document)(内含源代码和导出的文档) 1.1 JavaDoc概述 1.2 文档注释的格式 1.3 IDEA生成API文档 vaDoc是Java自带的一种工具,其...我们可以通过Eclipse来实现Java文件的API文档生成。

    系统源代码说明书-模板.docx

    系统源代码说明书是软件系统开发过程中的重要文档,旨在为开发者、测试者和维护者提供详细的系统说明和指导。本文档模板提供了一个基本结构,涵盖了系统源代码的各个方面,包括文档目标、名词术语、目标读者、参考...

    AVR系列源代码生成软件

    AVR系列源代码生成软件是一款专为电子工程师和嵌入式开发者设计的辅助工具,它主要针对Atmel公司的AVR微控制器(Microcontroller)系列,帮助用户快速生成和编辑源代码。这款软件简化了开发过程,提高了编程效率,...

    软著60页代码整理生成工具V1.2

    该软件能帮助程序员将代码直接整理组织成申请软件著作权所需的源代码文档,本文件生成全部代码文档(备查),60页代码(前后各30页)提交申请用,文档格式为PDF版,需要注册,未注册的会在文档有“未注册”的字样。...

    MATLAB生成Gif图片程序源代码.rar

    MATLAB生成Gif图片程序源代码.rarMATLAB生成Gif图片程序源代码.rarMATLAB生成Gif图片程序源代码.rarMATLAB生成Gif图片程序源代码.rarMATLAB生成Gif图片程序源代码.rarMATLAB生成Gif图片程序源代码.rarMATLAB生成Gif...

    利用强化学习方法 DQN 生成基于机器学习的恶意流量检测模型+源代码+文档说明

    利用强化学习方法 DQN 生成基于机器学习的恶意流量检测模型+源代码+文档说明,含有代码注释,新手也可看懂,个人手打98分项目,导师非常认可的高分项目,毕业设计、期末大作业和课程设计高分必看,下载下来,简单...

    软著源代码整理工具

    4. **生成文档**:自动生成源代码的README或CHANGES文档,概述项目结构、主要功能和更新历史。 5. **版本控制整合**:如果源代码在版本控制系统(如Git)中,工具可能能帮助提取特定版本的代码,便于提交至软著申请...

    C标准库源代码(学习C/C++必备)

    C标准库源代码,能提高对C的理解,不错的哦 下载文件列表 Pack : clibsource.rar C 标准库源代码\ABORT.C C标准库源代码\ABS.C C标准库源代码\ACCESS.C C标准库源代码\ADJUSTFD.C C标准库源代码\ALGRITHM C标准库源...

    25个经典网站源代码

    在IT行业中,源代码是构建网站的基础,它是由程序员用编程语言编写的指令集合,用于告诉计算机如何执行特定任务。这个资源"25个经典网站源代码"提供了一个宝贵的参考资料库,适合初学者和经验丰富的开发者参考,以...

    自动生成软著申请所需的项目源代码Word文档_SourceCodeDocxGeneratorCompose.zip

    自动生成软著申请所需的项目源代码Word文档_SourceCodeDocxGeneratorCompose

    Tapestry 5.2.0 (alpha) api文档 chm (根据官方提供的源代码生成的doc文档) 天涯浪子

    Tapestry 5.2.0 (alpha) api文档 chm (根据官方提供的源代码生成的doc文档) 天涯浪子

    PLC 底层源代码

    《PLC底层源代码解析——以FX1N与51单片机为例》 PLC(可编程逻辑控制器)在工业自动化领域扮演着至关重要的角色,而深入理解其底层源代码则是提升系统设计与调试能力的关键。本文将以三菱FX1N系列PLC为例,结合IAP...

    基于python爬取新浪微博爬虫以及生成词云源码+源代码+文档说明(高分项目)

    基于python爬取新浪微博爬虫以及生成词云源码+源代码+文档说明(高分项目)本资源中的源码都是经过本地编译过可运行的,评审分达到95分以上。资源项目的难度比较适中,内容都是经过助教老师审定过的能够满足学习、...

    提取文件夹下指定格式的所有源代码放入Word文档

    提取文件夹下指定格式的所有源代码放入Word文档 1.修改配置文件 2.双击exe启动 3.选择配置文件 4.自动读取生成Word文件 配置说明: { //Word保存路径 "outputFile": "D:\\Projects\\temp\\source-code-collector\...

Global site tag (gtag.js) - Google Analytics