精华内容
下载资源
问答
  • 代码生成文档工具

    千次阅读 2010-12-01 17:53:00
      1 doxygen是大名鼎鼎代码文档工具。 下载地址:www.doxygen.org<br />安装它。 2 Graphviz 这个工具配合doxygen使用,可以提取函数,模块之间的调用关,非常清晰。 下载地址:...

     

    1 doxygen是大名鼎鼎代码文档工具。

    下载地址:www.doxygen.org

    安装它。

    2 Graphviz

    这个工具配合doxygen使用,可以提取函数,模块之间的调用关,非常清晰。

    下载地址:http://www.graphviz.org/Download..php 

    下面是Graphviz提取出来的一些关系图:

        

     

     

     

     

     

    3 htmlhelp

    这个工具把doxygen生成的html文件,转化为一个CHM文件,看起来方便些。

     下载地址:

    http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en

    安装它。

    全部安装后就可以开始使用了。

    运行doxygen wizard.exe

         运行doxywizard.exe,这时按照doxygen根目录下的文档(doxygen_manual-1.5.2.chm)中 Doxywizard usage一节的说明设置即可。主要包括,源码路径、工作路径、输出路径等。

    点开始,即可生成文档

    最后对文档生成过程中遇到的一些问题进行说明:

    1 中文问题:中文注释在文档中是乱码。

    解决:在expert中的INPUT选项页的INPUT_ENCODEING中填入“GB2312”,这样基于GB的文本编辑器生成的代码就可以正常使用了。

     

     

    2 图形问题:无法绘制类图协作图等图形。

    首先确保安装了graphviz for win,注意不是wingraphviz,后者是一个graphviz的com封装,但是doxygen并不是基于它开发的,所以装了也没用。然后在 expert的DOT_PATH中填入graphviz的安装路径。接着在wizard的diagram中选择需要生成的图形类别就可以了。

    如果出现无法包含.map文件的错误,可以将工作目录设置成html,并将html中所有文件都清除再试。这个问题的原因还不太确定。

    3 输出chm的问题:如何输出.chm文件

    1. 你必须安装微软或其相兼容的chm编译系统。通常为HTML Help Workshop。

    2. 首先在[Wizard...]的Output页面中,选择HTML,然后选择到prepare for compressed HTML(.chm)。

    3. 其次在[Expert...]的HTML页面中,将HHC_LOCATION指向微软的hhc工具。通常为C:/Program Files/HTML Help Workshop/hhc.exe。然后点击OK,保存,编译即可。

     

    HHC_LOCATION中输入hhc.exe文件的路径。hhc.exe可以通过安装HTML Help Workshop获得。

     

    4 如何像MSDN那样在左边的树中显示函数列表?

    打开[Expert...]的HTML页面,然后选中TOC_EXPAND即可。

     

    5 如何去掉CHM附带的CHI文件?

    注意在默认情况下,CHM会有一个CHI文件,似乎是用来加速索引的。我本人也遇到过很多用户仅仅上传了CHM,而没有上传CHI文件,导致无法正常显示的情况。我不知道是否可以通过工具重建CHI文件,但是我觉得关闭这个功能即可。打开[Expert...]的HTML页面,取消GENERATE_CHI 即可。

    6 如何像MSDN那样右边每页显示一个函数?

    这个问题其实比较棘手,在[Expert...]中的 Project页面,下面有一个选项叫做SEPARATE_MEMBER_PAGES,把这个选项选中,这样每个函数就是一个页。但是会有一个问题,那就是右边页面的旁边多了所有函数的列表。很遗憾,经过研究,这个确实无法去掉。我的解决方法就是自己编译一下doxygen,在 memberlist.cpp的writeDocumentationPage函数中将 container->writeQuickMemberLinks(ol,md);连同附近几行屏蔽掉即可。

    7 如何在CHM中去掉当选择SUBGROUPING后去掉分组的组信息?

    这个功能就是在chm的左边树中直接列出函数列表,而不用点击看右边页面了。这个功能需要修改源代码。在index.cpp中,屏蔽 writeGroupIndexItem函数的 Doxygen::indexList.addContentsItem,Doxygen::indexList.incContentsDepth和 Doxygen::indexList.decContentsDepth();即可。

    8 如何修改或者去掉右下脚Generated at ...的文字?

    打开[Expert...]的HTML页面,然后在HTML_FOOTER中指定相应的HTML文件即可。注意HTML_FOOTER中至少包含BODY和 HTML结束标记。即一个最小的尾部HTML至少是这样</BODY></HTML>。同理,如果你要指定了 HTML_HEADER,他至少包含<HTML><HEAD></HEAD><BODY>

    9 如何生成组?

    组就是可以把同类的函数放到一个根下的显示方式。doxygen支持grouping,即你可以把相关的代码通过标志,放到同一个组中,便于查看。这主要是通过几个内置语法命令。首先通过@defgroup定义一个组,然后要把分组的函数或者类等,通过标志@ingroup加入相应的组。这样,相应的函数就被放置在同一个组中。

    10 如何生成中文帮助?

    点击[Expert...],在页Project 的OUTPUT_LANGUAGE,选择Chinese,这样输出的帮助提示信息就是中文。具体中文提示信息的文字在源代码中。

     

     

    11 如何彻底解决DoxyGen的输出中文chm的乱码问题?

    DoxyGen的实现中大概有三处编码的设置。首先是,doxyfile,也就是配置文件。其次,INPUT_ENCODING,也就是DoxyGen需要解析的输入文件的编码。最后,就是输出的编码。譬如CHM左边的索引编码。

    首先是chm的标题乱码,这个比较好解决,因为DoxyWizard使用QT做的界面,它内部做了转换,所以在DoxyWizard中输入中文,在保存的时候,他自己做了转码,导致doxyfile中的最终的保存信息不正确。这个时候只需要用记事本打开doxyfile配置文件,输入相应中文即可。注意保存的时候保存成ANSI编码即可。保存成其他格式的话可能需要去掉BOM,比较麻烦,没研究了。这个相应的编码设置在[Expert...]中,页 Project 的 DOXYFILE_ENCODING,不输入或者默认为UTF-8都行。

    其次是右边内容乱码,这个多半是因为你没有配置好输入的文件编码类型造成的。在[Expert...]的Input页面中,有一个INPUT_ENCODING,这个选项表示输入文件的编码方式,这要和你处理的源文件格式一致。对于我们来说(使用vs的人),一般设置为GB2312。当然,再次声明,编码方式取决于源文件的编码方式。如果文件编码已经是UTF-8了,然而你还将其设置成GB2312,那么DoxyGen会将UTF-8当成ANSI再进行一次UTF-8转换,自然会出错了。

    最后也是经常遇到的问题就是DoxyGen生成的CHM文件的左边树目录的中文变成了乱码。这个只需要将chm索引的编码类型修改为GB2312即可。在 HTML的CHM_INDEX_ENCODING中输入GB2312即可。然而这种方法下,还有一个瑕疵之处,就是chm的搜索页的搜索结果中显示的中文文字却变成乱码了。这是因为DoxyGen默认开启了HTML Help Workshop的Full-text search全文搜索选项,他在进行全文搜索的时候,应该是打开文件然后按照ANSI进行搜索的,(资料表示HHW不支持UTF-8,仅支持ISO- 8859-1或者windows-1252编码。)而Doxygen生成的右边界面统一是UTF-8,这自然出现了问题。而在这种情况下做全文搜索,理论上只能搜索英文。

            我们的解决方案只能是重新编译DoxyGen代码,为了满足搜索,只要保证右边的页面文件不是UTF-8即可。我们首先修改writeDefaultHeaderFile这个函数的代码,将其charset=GB2312。然后在 TranslatorDecoder的构造函数中修改m_toUtf8 = (void*)-1;即屏蔽文本写入时最终的转换函数。最后删除INPUT_ENCODING的设置或者输入UTF-8。这样会使DoxyGen认为我们的文本是UTF-8的,从而不用进行转换。生成替换原始的DoxyGen即可。

    另外需要补充的是,还有一种方案是不用修改作者的源代码,但是需要将DoxyGen生成的右边的HTML文件使用工具(如iconv)手工转换成GB2312,然后再使用HTML Help Workshop生成,网上有篇文章介绍过,我测试一下,也是没有问题的。

           最后,doxygen是一个开源项目,并且支持vs2005项目,这样一来,如果你觉得哪里不顺手,完全可以把代码下载后自行编译。

            这样,基本上就能够用doxygen生成漂亮的文档了。代码方面,doxygen支持多种格式的注释风格,根据manual选择自己喜欢的就好。

     

    源文档 <http://blog.cs.swust.edu.cn/index.php?op=ViewArticle&articleId=1670&blogId=91>

     

    展开全文
  • 软著申请60页的源代码文档生成工具

    万次阅读 多人点赞 2019-08-21 10:37:31
    工具名称:源代码文档生成工具 使用范围:软著申请时制作代码文档使用 查看地址:https://www.chtml.cn/product/show/10955 作者名:it-er (csdn主页) 使用说明: \软著源代码整理\bin\Release\SourceConvert....

    工具名称:源代码文档生成工具
    使用范围:软著申请时制作代码文档使用
    查看地址:https://www.chtml.cn/product/show/10955
    作者名:it-er (csdn主页

    在这里插入图片描述
    使用说明:
    \软著源代码整理\bin\Release\SourceConvert.exe点击启动文件 ,然后选择代码所在的目录,进行生成代码文档所需要的代码内容。

    展开全文
  • 由于最近在写C#代码时,需要编写代码结构说明文档,在文档当中把类中的属性和方法进行编写。慢慢发现,该部分工作都是简单粗暴无营养的,所以需要开发工具来自动化生成代码结构的文档说明。 1.2 设计 单文件【CS】...

    1.1 需求

    由于最近在写C#代码时,需要编写代码结构说明文档,在文档当中把类中的属性和方法进行编写。慢慢发现,该部分工作都是简单粗暴无营养的,所以需要开发工具来自动化生成代码结构的文档说明。

    1.2 设计

    单文件【CS】操作流程: 选择单文件(.cs)文件 -> 选择输出内容 -> 选择单文件-> 计算 ->打印日志 ->生成结构文档。

    多文件【CS】操作流程:选择文件夹 -> 选择输出内容 -> 选择单文件-> 计算 ->打印日志 ->生成结构文档


    1.3 实现效果

    单文件【CS】操作界面:


    多文件【CS】操作界面:



    导出文件效果:


    1.4 工具下载

        下载地址 : http://download.csdn.net/download/chr23899/10151324 

        



    展开全文
  • 张三:假如我们自己开发了一个类库,怎么做一个方便阅读的文档呢? 李四:一个方法一个方法地写呗,就像写Excel文档一下。...为什么不玩玩doxygen工具,它能帮你生成文档? 李四:这么爽,什么东东,给说讲讲。

    转载:http://blog.csdn.net/leehong2005/article/details/9137889

    张三:假如我们自己开发了一个类库,怎么做一个方便阅读的文档呢?

    李四:一个方法一个方法地写呗,就像写Excel文档一下。

    张三:啊,你out了,这多慢呀。为什么不玩玩doxygen工具,它能帮你生成文档?

    李四:这么爽,什么东东,给说讲讲。


    1. Doxygen, what?

    Doxgen就是大名鼎鼎的文档生成工具,而且是免费开源的,它使用非常方便,能提取C++,Java,Objective-C,Python,IDL,PHP,C#等语言的注释,从而生成文档。

    你可以访问其官方网站,下载安装包,它的官网上有详细的使用手册。

    http://www.doxygen.nl/index.html

    支持的主要语言格式


    Extension Language
    .idl IDL
    .ddl IDL
    .odl IDL
    .java Java
    .cs C#
    .c C
    .cpp C++


    可产生出来的文档格式有:

    • HTML
    • XML
    • LaTeX
    • RTF
    • CHM 

    要让工具能提取注释,那么就要求你写的注释要按照一定的规则来写,不能乱写,不然该工具是无法识别的,通常在Java中,只要JavaDoc能识别的,doxgen也能识别。


    2. 安装Doxygen

    我们可以在这个网址去下载最新的安装包

    http://www.doxygen.nl/download.html#latestsrc

    安装过程就不用说了,很简单,直接Next,最后Finish就OK了。


    3. 配置Doxygen

    配置doxgen是最核心的,你可以设置你要提取注释的源文件,生成的文档格式,工程名称,文档的Logo等信息,这些配置是可以存储起来的,当你的源代码更新后,重新再运行这个配置文件,就可以重新生成一个新的文档。

    在安装后,进入到其安装目录下的bin文件夹,它里面有两个文件:doxygen.exe和doxywizard.exe,我们先运行doxywizard.exe来进行配置,从而生成配置文件(如果是第一次运行)。


    图1,Doxygen配置主界面。

    1,Doxygen工作目录,就是用来存储配置文件的目录。

    2,递归搜索目录需要选上。


    图2,选择输出文档格式


    图3,生成类图


    图4,选择文档的编码格式。

    说明:编码格式,UTF-8 是首选。如果需要显示中文则选择GB2313


    图5,设置提取的范围。


    图6,设置源码的格式。


    图7,设置生成CHM文件属性。


    图8,配置完成后,点击"Run doxygen"来运行配置,最后,点击File->Save存储配置文件,下次就不用再配置了。

    4. 输出文档示例

    下面的图片示例了输出的文档格式(HTML),很简单实用,同时还能支持Search。 

    图9,列出所有的包名。 


    图10,具体某一个类的详细注释,可以列出所有的公有方法,你的代码注释写得越详细,那么生成的文档也就越详细。 


    展开全文
  • 代码规范文档

    千次阅读 2015-12-31 19:53:43
    代码规范文档代码规范文档目录 1 概述 5 1.1 编写目的 5 1.2 文档约定 5 1.3 预期的读者和阅读建议 5 1.4 参考文献 5 2 排版要求 5 2.1 程序块缩进 5 2.2 程序块之间空行 5 2.3 长语句和长表达式 6 2.4 ...
  • jsdoc-toolkit文档工具使用说明

    千次阅读 2013-03-15 10:53:51
    JsDoc Toolkit 是一款辅助工具,你只需要根据约定在 JavaScript 代码中添加相应的注释,它就可以根据这些注释来自动生成API文档。对Java 熟悉的人可能会发现它和 Java 的文档自动化工具 JavaDoc 很像,没错,JsDoc ...
  • 使用GhostDoc为代码生成注释文档 ... C#中XML格式的文档注释好处多多:Visual Studio会在很多地方显示这些注释内容(例如,编辑器的工具提示或对象浏览器),还有一些工具(比如NDoc或微软的文档工具Sandcas
  • 在线接口文档管理工具(小幺鸡)使用说明前言小幺鸡的地址:http://www.xiaoyaoji.cn/几大看点:在线接口测试; 可视化编辑与分享; 代码开源。可以离线部署。
  • 在步入正题前,发个牢骚。 前天总公司的一个技术经理下达一个任务...我承认是下载了网上的一个例子,也从java的官方网站中copy了一些他们的代码,但是,绝对没有全部的copy,很多都是这几年实践下来的经验,还有文档
  • 坚持把遇到的问题整理出来,供大家参考(企鹅...今天给大家推荐一个不错的在线文档工具,以下内容来自ShowDoc 官方说明:   ShowDoc是什么   每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码...
  • 再读华为代码规范文档

    万次阅读 2013-06-23 20:39:27
    两年前,开始编程前,读过华为代码规范文档,以后一直按该文档要求自己,两年后,再读,另有收获,发现这些问题,自己平时还是没有注意到。 1.关于函数使用: 1.1 接口函数参数 在同一项目组应明确规定对接口函数...
  • 在线API文档、技术文档工具ShowDoc

    千次阅读 2016-11-18 13:17:10
    【个人开源作品】在线API文档、技术文档工具ShowDoc ShowDoc是什么 每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?!Show me the doc !! 程序员都很希望...
  • Doxygen代码注释规定和生产文档说明

    千次阅读 2006-11-24 14:00:00
    Doxygen是一个程序的文档产生工具,可将程序中的特点注释转换成为说明文件。安装与初始化 请到http://www.stack.nl/~dimitri/doxygen/doxygen_usage.html上面下载最新版本的doxygen。下载针对Windows 95/98/ME/NT/...
  • 本文是一个静态代码分析工具的清单,共有30个工具。包括4个.NET工具、2个Ada工具、7个C++工具、4个Java工具、2个JavaScript工具、1个Opa工具、2个Packaging工具、3个Perl工具、1个Python工具、1个嵌入式工具、2个二...
  • 1、新增自定义文件功能,可以自己编写模板生成任意代码的文件。 2、新增数据源配置自动生成功能,项目分库分表不用愁,一次搞定所有数据源。 3、公共参数界面新增表别名和是否目录直通的配置。 4、生成Bean界面...
  •  本文是一个静态代码分析工具的清单,但是为公司产品需要付费使用。共有37个公司,有些公司包含多个工具。其中27个公司有多语言 工具,1个公司为PHP工具、2个公司为.NET工具、1个公司为Ada工具、4个公司为C++...
  • Vue项目开发最新、最全代码规范文档

    千次阅读 多人点赞 2019-02-21 10:43:49
    一、 目录结构 ... |— check-versions.js 版本验证工具 |— utils.js 构建相关工具方法(主要用来处理css类文件的loader) |— vue-loader.conf.js 处理vue中的样式 |— webpack.base.conf.j...
  • 微信JS-SDK说明文档

    万次阅读 2015-01-27 14:02:53
    微信JS-SDK说明文档
  • 通用WEB项目DEMO说明文档

    千次阅读 2018-11-02 16:39:40
    通用WEB项目DEMO说明文档通用WEB项目DEMO说明文档项目结构说明遵循原则:约定大于规范混淆说明后端代码开发文件结构约定Mybatis自动生成properties文件参数引入AOP处理日志打印异常处理common包代码关于对外接口前端...
  • c++代码文档化注释

    千次阅读 2018-10-10 14:42:29
    近段时间,一直在学习华为C语言编程规范(2011版),在“注释”这一章中发现了一种“Doxygen”的注释转文档工具,查看诸多相关资料,并进行编程实践,终于可以利用Doxygen给C程序生成注释文档。在使用过程中,我已经...
  • 数据库文档自动生成工具

    万次阅读 2018-07-04 16:06:14
    这就让人很蛋疼,考虑到后期维护与运维的感受,数据库文档代码一样是一个项目不可缺少的一部分,所以今天准备编写数据库文档,但突然发现,每一个项目都有数据库文档,数据库文档格式统一固定,为什么不利用...
  • Word文档批量替换工具

    千次阅读 2019-07-01 11:25:01
    日常工作中可能会碰到这样的情况,就是需要批量替换一些文件的内容,如合同、产品说明、ISO认证标准化文档(质量手册、程序文件、管理手册)、项目推广方案等,先做批量替换,再进行修改,可以节省大量时间。...
  • 作为一名后台开发人员,平时工作中经常需要编写数据库表结构说明文档,手动编写显然不符合程序员的风格,在网上找了一些工具大多只支持单一类型的数据库,于是决定自己动手写一个。工具下载链接。 工具使用说明 ...
  • 代码质量工具总结

    万次阅读 2018-10-13 11:59:02
    代码质量检测工具 PMD FindBugs checkstyle SonarLint/SonarQube alibaba coding guiding 仅仅有质量检测工具还不够,还需要代码审查工具,加以人工审查辅助 代码审查工具简介 Review Board Gerrit GitLab...
  • Godoc - golang 注释与文档工具

    万次阅读 2018-04-11 01:24:55
    Godoc - golang 注释与文档工具 基本规则 The Go project takes documentation seriously! 所以godoc横空出世了 规则很简单,用其中的一句话就可以说明: to document a type, variable, constant, function...
  • Mac OS 下统计代码行数的工具

    千次阅读 2015-12-23 20:07:39
    Mac OS 下统计代码行数的工具
  • API文档自动生成工具

    万次阅读 2017-02-18 16:51:31
    API文档自动生成工具   ----------------------------------------------------------------------------------------------------------------   第二行给个自我介绍: 我是一个很懒很懒的PHP程序猿...
  • 【QT】Qt的自文档工具qdoc

    千次阅读 2015-04-08 13:14:02
    所谓自文档化,就是把文档代码合二为一,既增强了文档的可维护性,又增强了代码的可读性,一举两得,何乐而不为呢? 在Qt开发中,就有这样的自文档工具:qdoc。使用qdoc,通常分三步走。 第一步,添加QDoc注释到...
  • 便利的开发文档工具-doxygen

    千次阅读 2004-12-19 15:22:00
    便利的开发文档工具-doxygenmounton @ {www.ihere.org} ( mount0n@yahoo.com)2003年8月0. 序言为代码写注释一直是大多数程序员有些困扰的事情。当前程序员都能接受为了程序的可维护性、可读性编码的同时写注释的说法...
  • Chrome 开发者工具官方中文文档

    千次阅读 2018-11-07 12:03:25
    传送门 Chrome开发者工具官方中文文档 front-end-study系列

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 401,527
精华内容 160,610
关键字:

代码说明文档工具