帮助文档制作工具开源

2024-08-18

.NET平台开源项目速览(4).NET文档生成工具ADB及使用

很久以前就使用ADB这个工具来生成项目的帮助文档.功能强大,在学习一些开源项目的过程中,官方没有提供CHM帮助文档,所以为了快速的了解项目结构和注释.就生成文档来自己看,非常好用.这也是一个学习方法吧.例如本文在: .NET平台开源项目速览(2)Compare .NET Objects对象比较组件 .NET平台开源项目速览(3)小巧轻量级NoSQL文件数据库LiteDB 上述2篇文章中最后的资源中就手动制作了CHM帮助文档.有时候我们还可以对源码进行翻译,再制作,效果还不错.今天介绍的ADB工具

微软开源全新的文档生成工具DocFX

微软放弃Sandcastle有些年头了,微软最近开源了全新的文档生成工具DocFX,目前支持C#和VB,类似JSDoc或Sphinx,可以从源代码中提取注释生成文档之外,而且还有语法支持你加入其他的文件链接到API添加额外的说明,DocFX会扫描你的源代码和附加的文件为你生成一个完整的HTML模版网站,你可以自己通过模版定制,目前已经内嵌了几个模版,包括静态的HTML页面和AngularJS页面.你还可以自己定制模版,具体参考 how to create custom template. 源代码

showdoc 开源在线api&&技术文档管理工具

showdoc 是一个很不错的api 以及技术文档管理工具环境准备 doker-copose 文件 version: "3" services: doc: image: registry.docker-cn.com/star7th/showdoc volumes: - "./showdoc_data/html:/var/www/html/" ports: - "8080:80" 启动&&配置启动 docker-compose

（转）Doxygen文档生成工具

http://blog.csdn.net/lostaway/article/details/6446786 Doxygen 是一个支持 C/C++,以及其它多种语言的跨平台文档生成工具.如同 JavaDoc, doxygen 直接从源文件中提取符合 doxygen 注释规范的注释,生成文档[1]. 1.安装 1.1 安装 Doxygen 1.7.4(Windows) 地址:ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.4.windows.bin

Sandcastle----强大的C#文档生成工具

最近客户索要产品的二次开发类库文档,由于开发过程中并没有考虑过此类文档,而且项目规范比较,持续时间比较长,经手人比较多,还真是麻烦,如果人工制作文档需要是一个比较大的工程.还好有这个文档生成工具,能够根据项目生成文档,而且格式看起来确实很专业. Sandcastle是微软官方的文档生成工具,NDoc开发停止后,这个貌似也是唯一的一个这方面的工具.它从dll文件及其xml注释文件能够生成完整的帮助文档,支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,Hel

使用Objective-C的文档生成工具:appledoc

使用Objective-C的文档生成工具:appledoc 前言做项目的人多了,就需要文档了.今天开始尝试写一些项目文档.但是就源代码来说,文档最好和源码在一起,这样更新起来更加方便和顺手.象 Java 语言本身就自带 javadoc 命令,可以从源码中抽取文档.今天抽空调研了一下 objective-c 语言的类似工具. 从 stackoverflow 上找到三个比较 popular 的工具:doxygen, headdoc 和 appledoc .它们分别的官方网址如下: docxygen

使用Objective-C的文档生成工具

前言做项目的人多了,就需要文档了.今天开始尝试写一些项目文档.但是就源代码来说,文档最好和源码在一起,这样更新起来更加方便和顺手.象Java语言本身就自带javadoc命令,可以从源码中抽取文档.今天抽空调研了一下objective-c语言的类似工具. 从stackoverflow 上找到三个比较popular的工具:doxygen, headdoc和appledoc .它们分别的官方网址如下: docxygen http://www.stack.nl/~dimitri/doxygen/ind

文档生成工具doxygen+图像生成工具GraphViz

文档生成工具doxygen+图像生成工具GraphViz 虽然jdk自带的javadoc也很好用,不过使用doxygen+GraphViz 的组合可以生成许多强大的图(类图.协作图.文件包含/被包含图.函数调用/被调用图.类继承体系图等),另外,doxygen支持直接生成chm文档,支持LaTeX公式,如果你有一个支持php的服务器,生成的html还可以加入一个搜索框. doxygen是开源的C语言软体,可以在它的官方网站上下载到软体和源码:http://www.stack.nl/~dimitr

Struts2 API的chm格式帮助文档制作教程

Struts2 API的chm格式帮助文档制作教程在SSH三个框架中,Struts2的API文档是最难做的,这里所说的格式是chm格式的,chm的格式很方便,Hibernate API文档和Spring API文档只要通过相应的工具,和对应的javadoc就可以制作了,但是Struts2这个框架是两个框架结合的产物,所以官方将这两个框架单独的做成了API文档,如果要做需要分成两个API文档了.不利于我们的管理和查找.在开始学习Strust2的时候,就跟着视频学做API了,但是没有成功,昨天学S

Markdown 文档生成工具

之前用了很多Markdown 文档生成工具,发现有几个挺好用的,现在整理出来,方便大家快速学习. loppo: 非常简单的静态站点生成器 idoc:简单的文档生成工具 gitbook:大名鼎鼎的文档协作工具 docsify:一个神奇的文档站点生成器,简单轻巧,无需静态构建html 教程版: http://me.52fhy.com/learn-markdown-generate-tool/#/ loppo 官网: https://github.com/ruanyf/loppo 依赖 node.js

help文档制作 chm

程序中的help文档制作所用工具:HTML Help Workshop 文件包括:各个html文档,帮助页面的具体内容 hhc文档:help的目录文件 hhk文档:help的索引文件 MAP文件夹中放图片文件 hhp文件打开可以进行编辑每个帮助页面都是由一个个html文件构成,就是网页制作,比较简单.需要注意文字的编码.还有chm文件的文字编码设置. <html lang="zh-cmn-Hans"> <head> <meta http-equiv=

【转载】Java Restful API 文档生成工具 smart-doc

谁说生成api文档就必须要定义注解? 谁说生成接口请求和返回示例必须要在线? 用代码去探路,不断尝试更多文档交付的可能性. 如果代码有生命,为什么不换种方式和它对话! 一.背景没有背景.就自己做自己的背景在当今各种盛行的前后端分离.restful service开发过程中,接口文档是必不可少的.对于前后端分离的开发中,后端开发需要将接口写好后需要告诉前端工程师接口的请求参数.响应示例等重要信息,而对于对外暴露的restful接口服务,我们提供接口也是需要具备相同的接口文档的. 但是对于后端工

REST api文档管理工具

问题: 不同软件/程序在网络中互相传递信息不统一. 交互不便. REST API 作用: RESTful API就是一套协议,用来规范多种形式的前端和同一个后台的交互方式. 原理: 组成/流程/规范: 遵守OpenAPI规范软件的REST API文档问题: 在API的迭代开发过程中,文档更新工作容易遗漏. swagger框架功能: 生成遵守OpenAPI规范的.JSON或YAML格式的RESTful API文档. 实现: 读取嵌入到源代码中的api文档,生成api文档. swagger规范

Doxygen自动文档生成工具在Eclipse中的集成及使用举例

你有为软件编写说明文档的苦恼吗?当别人甩给你一个庞大的系统,让你根据里面的代码注释理解后写出一份完整的开发文档,你会怎么办?一个个的看代码然后耗时N天来写吗?这既是一份苦差事也极其耗时,有没有更好的办法呢?比如根据代码注释自动生成详尽的说明文档……可能有人会说用Javadoc就是了,要是C/C++.Python.C#等语言写的软件呢?有没有类似Javadoc的东西? Yes,当然有,Doxygen就是这样一个能满足你需求的工具.Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的

工具：使用过的 API 文档生成工具

背景 2012 年之前几乎没有为代码增加注释,当然,代码的命名也不见得合理(好的代码胜过面面俱到的注释),后来接触过一些开源框架,优秀的框架都有一个特点:文档和示例非常多,在后来的日子里,几乎会强制自己为代码写注释,可能是有点过犹不及了,不过凡事都会经过这个初级阶段,本文总结一下使用过的文档生成工具. Javascript 文档生成工具 Javascript 这种动态语言更应该写注释. YUIDoc 网址:http://yui.github.io/yuidoc/. JsDuck 网址:https

Api接口文档管理工具，你知道哪些呢？

上周看到有人在我的Github开源项目中提了个issue,说是否考虑接入swagger.那今天我就用swagger与其他接口文档工具做对比,同时说说Api接口文档工具的那点事.如今,在前后端分离开发的这个年代,Api接口文档管理工具越来越显得重要.完整的Api接口文档能大大提升前后端开发协作的效率. image 目前市场有哪些比较优秀的接口文档管理工具呢?Swagger Api接口文档工具到底如何,我大致汇总一下吧! 一.Swagger 说到Swagger,他确实是为开发者发明的一款神器,他可以

Javadoc文档生成工具-自定义版

先上图来一波本身JDK自带了doc文档生成工具,但是不支持排除类,方法,属性,虽然有个@deprecated可以使用,但是达不到我想要的结果(类会被标记为废弃类,编译使用时会提示), 而且类说明示例代码不支持高亮,排版也不行,搜索万能的网友的答案,发现没找到合适的,,,然后就开始漫长的实现.虽然有些地方不完善,没有完全按照官方的全部实现. 1.实现的功能几十种代码高亮的样式,结合自开源的js. @exclude排除生成类.方法.属性 @link高亮提示自定义布局比例以及一些简单注解@ve

API文档管理工具

系统庞大之后,前后端分离开发,前端调用后端提供的接口,请求协议一般是 HTTP,数据格式一般是 JSON.后台只负责数据的提供和计算,而完全不处理展现逻辑和样式:前端则负责拿到数据,组织数据并展现的工作.这样结构清晰,关注点分离,前后端会变得相对独立并松耦合.好处多多. 但是这样带来很多问题,前端可能需要拿到后端的数据之后,才能开始开发工作,等前端开发完成之后,然后再与后端一起联调.耗时不说,如果业务的需求更改,后端接口变更,怎么快速便捷告知前端的开发人员?还有其他如文档维护和及时更新的问题.这

DBCHM -最简单、最实用的数据库文档生成工具

项目介绍 DBCHM 是一款数据库文档生成工具! 该工具从最初支持chm文档格式开始,通过开源,集思广益,不断改进,又陆续支持word.excel.pdf.html.xml.markdown等文档格式的导出. 本项目力求做最简单.最实用的数据库文档(字典)生成工具! 支持的数据库 SqlServer MySQL Oracle PostgreSQL DB2 SQLite 主要功能文档的内容都包含什么? 序号 | 列名 | 数据类型 | 长度 | 小数位数 | 主键 | 自增 | 允许空 | 默认

基于WPF重复造轮子，写一款数据库文档管理工具（一）

项目背景公司业务历史悠久且复杂,数据库的表更是多而繁杂,每次基于老业务做功能开发都需要去翻以前的表和业务代码.需要理解旧的表的用途以及包含的字段的含义,表少还好说,但是表一多这就很浪费时间,而且留下来的文档都是残缺不全,每次查一些表的含义都要捯饬很久.在网上搜索关于数据库文档管理工具搜到最多的就是Screw和DBCHM,一个是基于Java的工具.另一个则是bug很多,表一多就一直转圈圈进不去.所以自己就动手开发了这款SmartSQL的工具. 它是一款基于.Net 4.6.1.WPF开发的一款数

帮助文档制作工具开源

推荐开源Api文档生成工具——Doxygen

.NET平台开源项目速览(4).NET文档生成工具ADB及使用

微软开源全新的文档生成工具DocFX

showdoc 开源在线api&&技术文档管理工具

（转）Doxygen文档生成工具

Sandcastle----强大的C#文档生成工具

使用Objective-C的文档生成工具:appledoc

使用Objective-C的文档生成工具

文档生成工具doxygen+图像生成工具GraphViz

Struts2 API的chm格式帮助文档制作教程

Markdown 文档生成工具

help文档制作 chm

【转载】Java Restful API 文档生成工具 smart-doc

REST api文档管理工具

Doxygen自动文档生成工具在Eclipse中的集成及使用举例

工具：使用过的 API 文档生成工具

Api接口文档管理工具，你知道哪些呢？

Javadoc文档生成工具-自定义版

API文档管理工具

DBCHM -最简单、最实用的数据库文档生成工具

基于WPF重复造轮子，写一款数据库文档管理工具（一）

热门专题

帮助文档制作工具 开源

热门专题

帮助文档制作工具开源