首先,打开IDEA,并找到Tools -> Generate JavaDoc- 可供查询的chm比那些HTML页面好看多了. 如果您用过JDK API的chm文档,那么您一定不会拒绝接受其它第三方API的chm文档,比起普通的javadoc网页,chm更无疑更合适用作手册. 可是虽然将html转换成chm的软件多不胜举,却没有合适的软件可以将javadoc转换成像JDK API那种模式.JDK的chm文档可以层叠展开到类和方法,能相当漂亮提供这个功能的我只找到了JavadocToCHM. Jav

使用doxygen 生成源代码的文档是相当方便的,本文就简单整理下doxygen的使用说明 1. 安装 关于安装的问题不做特殊的说明,这里直接使用命令安装, 源码安装不做介绍 ubuntu: sudo apt-get install doxygen centos sudo yum install doxygen 2. 配置文件配置 关于doxygen主要的部分就在于配置文件的配置, doxygen相当强大,所以配置文件内容有点多.这里只介绍一部分,大家有兴趣可以继续深入研究 (1) 重要标记 配

一.引子 用这两个工具可以自动的遍历代码,并且产生代码文档,我们先来看看效果,然后放出这两个工具的下载地址. 二.工具的下载地址 doxygen:http://www.stack.nl/~dimitri/doxygen/download.html graphviz:http://www.graphviz.org/ 三.使用步骤 首先安装doxygen,然后解压下载好的graphviz.接着打开doxygen,按照我下面的图示进行操作就好了. 最后点run就可以了. 附上doxygen能识别的一些

译者按: 代码要有规范的注释,遵从jsDoc规则来注释可以生成有用的文档. 原文: Generate docs and host it with JSDoc and GitHub Pages 译者: Fundebug 为了保证可读性,本文采用意译而非直译,并且对源代码进行了大量修改.另外,本文版权归原作者所有,翻译仅用于学习. 今天,我来分享如何快速生成JavaScript代码的文档,并且使用Github pages发布. 我首先创建一个示例类JokeMachine,它存储一个笑话列表,调用sa

go doc 工具会从 Go 程序和包文件中提取顶级声明的首行注释以及每个对象的相关注释,并生成相关文档. 一般用法: go doc package 获取包的文档注释,例如:go doc fmt 会显示使用 godoc 生成的 fmt 包的文档注释. go doc package/subpackage 获取子包的文档注释,例如:go doc container/list. go doc package function 获取某个函数在某个包中的文档注释,例如:go doc fmt Printf 

作者:jiangwenna    http://www.jiangwenna.com/windows-doxygen-doc/ Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C.C++.Java.Objective-C和IDL语言,部分支持PHP.C#.注释的语法与Qt-Doc.KDoc和JavaDoc兼容.Doxgen可以从一套归档源文件开始,生成HTML格式的在线类浏览器(或.chm格式),或离线的LATEX.RTF参考手册. 准备工作: 1.下载最新版本

一.工具 doxygen:http://www.stack.nl/~dimitri/doxygen/download.html graphviz:http://www.graphviz.org/ 二.步骤 首先安装doxygen,然后解压下载好的graphviz.接着打开doxygen,按照我下面的图示进行操作就好了. 最后点run就可以了. 原文来源:http://www.cnblogs.com/tianzhijiexian/p/4392924.html

下位机代码格式规范整合记录 注册 doxygen 账号获取doxygen 的 *.exe 执行文件 https://pan.baidu.com/s/1MF5v-Ts80BysmZtXSqONmg 提取码:l4br 进入Graphviz 首页下载Graphviz 软件*.mis 安装包  (可不选,但推荐) https://pan.baidu.com/s/1lIhc31LUvZNVK75r9ghtNA 提取码:12wo 安装.安装完成后: 打开Doxygen GUI frontend ,配置文档格

Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,可以从一套归档源文件开始,生成chm格式的文档.本文主要讲解如何在winddows下安装doxygen.     1.下载doxygen-1.8.8-setup.exe,下载地址为:           1)官方地址:http://www.stack.nl/~dimitri/doxygen/download.html           2)华军软件:http://www.onlinedown.net/soft/11701

当我们使用Java生成word文档时,通常首先会想到iText和POI,这是因为我们习惯了使用这两种方法操作Excel,自然而然的也想使用这种生成word文档.但是当我们需要动态生成word时,通常不仅要能够显示word中的内容,还要能够很好的保持word中的复杂样式.这时如果再使用IText和POI去操作,就好比程序员去搬砖一样痛苦. 这时候,我们应该考虑使用FreeMarker的模板技术快速实现这个复杂的功能,让程序员在喝咖啡的过程中就把问题解决.实现思路是这样的:先创建一个word文档,按

appledoc导出iOS代码文档的使用和问题详解(干货篇) 1. 简单说一下背景和自己感受 背景: 项目好像突然黄了,公司让详细写项目代码的注释并且导出文档,弄完之后就要封版. 说实话:听到这个消息之后心里还是很担心的,因为我知道公司不可能养闲人,我手上的项目本来年后就没有什么起色,加上突然来了这样的一个'噩耗',顿时就知道后面肯定没好事 我知道公司不会养闲人,所以在这几天项目闲下来的日子里,忐忑过,也想到了项目可能面临的种种,当然也包括自己所可能受到的种种影响.但是毕竟我们只是听上面安排的一

Go源码文件 文件类型 命令源码文件 : 声明自己属于main包且包含main函数的源码文件,一个包里边不要有多个命令源码文件,虽然用go install ,go run单独执行命令源码文件没有问题,但go install ,go run包含命令源码文件的文件夹时会出错. 库源码文件: 不具备命令源码文件两个特征的源码文件,也就是存在与某个包的普通源码文件.库源码文件安装后,相应的归档文件(*.a)被存放在当前工作区的pkg目录下. 测试源码文件:名称以_test.go为后缀的源码文件,且必须包

使用SHFB(Sandcastle Help File Builder)建立MSDN风格的代码文档 下载地址:http://sandcastle.codeplex.com/ 下载地址2:http://shfb.codeplex.com/downloads/get/1408995 根据这两种图就下一步下一步的安装.安装之后会在你的开始菜单里看到"Sandcastle Help File Builder"这个文件夹如下: 第二:我们来简单的建一个项目,写一个方法. public class

使用doxygen制作C代码文档 C 代码注释风格约定 行间注释 /*! * * 这里是注释 * */ 行内注释 <code here> /*! 这里是注释 */ doxygen 风格的宏 宏名可以是'\'或'@'后面跟宏名组成.如:\brief 或 @brief 表示一个简要说明在doxygen生成的html中, 前部分显示概要信息, 该信息后有个"更多" ,点击跳转到详细说明. 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏

PHPDocumentor是一个用PHP写的强大的文档自动生成工具,对于有规范注释的php程序,能够快速生成具有结构清晰.相互参照.索引等功能的API文档.旧版本是PHPDoc,PHPDoc是PEAR下面的一个非常优秀的模块,类似于Javadoc.从1.3.0开始,更名为phpDocumentor,新版本新加了对php5语法的支持,同时,可以通过在客户端浏览器上操作生成文档,文档可以转换为PDF.HTML.CHM等格式的文档,这样非常有利于代码的升级.维护.移交等. 前提:安装的前提是已经安装了

原创作品,允许转载,转载时请务必以超链接形式标明文章 原始出处 .作者信息和本人声明.否则将追究法律责任. 作者: 永恒の_☆ 地址: http://blog.csdn.net/chenghui0317/article/details/11990891 一.前言 SAX操作xml是基于事件来完成的,自己只负责调用解析的方法,然后具体解析操作都是交给DefaultHandler处理者来完成的,总的来说使用SAX解析和生成xml文档还是比较方便的 . 二.准备条件 因为SAX是jdk自带的解析方式,

参考:http://www.w3school.com.cn/tags/tag_pre.asp javadoc 生成帮助文档时,注意以下几点: 1.函数功能描述的结尾一定要有句号,英文句号或中文句号均可.不然会有方法摘要里会出现后边一大片内容. 2.换行用<p> 3.<pre> 元素可定义预格式化的文本.被包围在 pre 元素中的文本通常会保留空格和换行符.而文本也会呈现为等宽字体. public class JavadocDemo { /** * 这个函数的功能是返回你输入的字符串

前言 上一篇博客介绍了使用Nancy框架内部的方法来创建了一个简单到不能再简单的Document.但是还有许许多多的不足. 为了能稍微完善一下这个Document,这篇引用了当前流行的Swagger,以及另一个开源的Nancy.Swagger项目来完成今天的任务! 注:Swagger是已经相对成熟的了,但Nancy(2.0.0-clinteastwood)和Nancy.Swagger(2.2.6-alpha)是基于目前的最新版本,但目前的都是没有发布正式版,所以后续API可能会有些许变化. 下面

写项目时通常会遇到要求写开发文档的需求,但是就源代码来说,文档最好和源码在一起,这样更新起来更加方便和顺手.Objective-C 有一些文档管理工具,doxygen, headdoc 和 appledoc .它们分别的官方网址如下: docxygen http://www.stack.nl/~dimitri/doxygen/index.html headdoc http://developer.apple.com/opensource/tools/headerdoc.html appledoc

前言: 项目开发中遇到了需要将HTML页面的内容导出为一个word文档,所以有了这边随笔. 当然,项目开发又时间有点紧迫,第一时间想到的是用插件,所以百度了下.下面就介绍两个导出word文档的方法. 法一:通过jquery.wordexport.js导出word 备注:兼容IE9以上 大概浏览了下jquery.wordexport.js插件的代码,了解到了通过该插件可以导出文本和图片,而图片首先通过canvas的形式 绘制,文本则需要再依赖FileSaver.js插件,FileSaver.js插

一.安装 新建一个没有身份验证的mvc项目 - SwaggerMvc5Demo,然后添加一个名为Remote(自定义)且包含基础读写(不想手写)的ApiController   开源地址:https://github.com/domaindrivendev/Swashbuckle 使用以下方法来添加 Swashbuckle: 从“程序包管理器控制台”窗口:Install-Package Swashbuckle -Version 5.6.0 从“管理 NuGet 程序包”对话框中: 右键单击“解决