文档章节

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

找个没人用的名字
 找个没人用的名字
发布于 2016/04/12 10:36
字数 192
阅读 73
收藏 0
点赞 1
评论 0

背景

2012 年之前几乎没有为代码增加注释,当然,代码的命名也不见得合理(好的代码胜过面面俱到的注释),后来接触过一些开源框架,优秀的框架都有一个特点:文档和示例非常多,在后来的日子里,几乎会强制自己为代码写注释,可能是有点过犹不及了,不过凡事都会经过这个初级阶段,本文总结一下使用过的文档生成工具。

Javascript 文档生成工具

Javascript 这种动态语言更应该写注释。

YUIDoc

网址:http://yui.github.io/yuidoc/

JsDuck

网址:https://github.com/senchalabs/jsduck/wiki

C# 文档生成工具

SandCastle

网址:https://sandcastle.codeplex.com/

 

本文转载自:http://www.cnblogs.com/happyframework/p/3571045.html

共有 人打赏支持
找个没人用的名字
粉丝 0
博文 10
码字总数 2560
作品 0
徐汇
使用sphinx快速生成Python API 文档

不管是开源还是闭源,文档都是很重要的。当然理论上说,最好的文档就是代码本身,但是要让所有人都能读懂你的代码这太难了。所以我们要写文档。大部分情况,我们不希望维护一份代码再加上一份...

naughty ⋅ 2015/03/06 ⋅ 2

RESTFul接口测试工具:Wisdom RESTClient

Wisdom RESTClient 是由个人所开发的一款自动化测试REST API的工具。 它可以自动化测试REST API并生成精美的测试报告,同时基于测试过的历史数据,可以生成精美的REST API文档。 使用注意事项...

niithub ⋅ 05/01 ⋅ 0

使用grunt-jsdoc自动化生成javascirpt文档

背景 Javascript已经成为一门被人们重新认识的编程语言,由于大量JS开源框架的出现,利用Javascript开发的项目越来越多,越来越大。同时,也有越来越多Javascript开发问题暴露出来,如性能、...

knightuniverse ⋅ 2013/08/29 ⋅ 1

GP建模、GP服务发布测试、GP服务客户端调用及GP工具中输出图层

创建GP模型过程:;通过在客户端调用创建好的GP服务,可以方便和容易;但是对新手来说,网上相关可参考的文章太少实现的过;要点:;gp服务是在轻量级客户端调用的所以对输入输出参数;关于建...

sinat_34719507 ⋅ 2017/03/06 ⋅ 0

API文档编写工具

从网络上检索到一些与API文档编写工具相关的资料,特记录如下: APIDoc 一个简单的RESTful API文档生成工具,主要是对代码中的注释来生成文档。开源,http://apidoc.tools prmd 根据JOSN样式...

OpenIoT ⋅ 2016/07/28 ⋅ 0

docfx 做一个和微软一样的文档平台

开发中,有一句话叫 最不喜欢的是写文档,最不喜欢的是看别人家代码没有文档。那么世界上文档写最 la 好 ji 的就是微软了,那么微软的api文档是如何做的?难道请了很多人去写文档? 实际上微...

lindexi_gd ⋅ 2017/11/29 ⋅ 0

RESTful API 框架--Flask-Restaction

Flask-Restaction,为RESTful API而生的Web框架: 创建RESTful API 校验用户输入以及将输出转化成合适的响应格式 身份验证和权限控制 自动生成Javascript SDK和API文档 注意:仅支持Python3...

guyskk ⋅ 2015/10/12 ⋅ 0

Swagger2企业实战

一、引入swagger的目的 相信看这篇文章的小伙伴已经知道它的好处了,此次就不多说了,还不清楚的找谷歌、百度。 二、本文借用Swagger要实现的效果 1.后端人员在代码里根据swagger语法打些标签...

chenjiajun ⋅ 2017/12/30 ⋅ 0

jaywcjlove/idoc

AIP文档生成工具 简单的文档生成工具! 生成的页面预览效果 Details document ,, ,, `7MM ,M""bMM ,pW"Wq. ,p6"bo .JMML.Ybmd9' YMbmd' 全局安装 $ sudo npm install idoc -g 收录使用者 提交...

jaywcjlove ⋅ 2015/10/08 ⋅ 0

Eclipse用法:使用Javadoc导出项目的API文档

eclipse直接自动生成整个项目的API帮助文档的小tips 另外,eclipse加入doc注释的快捷键:Shift+Alt+J 本文将具体讲述使用Eclipse开发工具导出项目的Javadoc文档的步骤和常见的问题。 技术文档...

s360564346 ⋅ 2016/04/28 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

win10怎么彻底关闭自动更新

win10自带的更新每天都很多,每一次下载都要占用大量网络,而且安装要等得时间也蛮久的。 工具/原料 Win10 方法/步骤 单击左下角开始菜单点击设置图标进入设置界面 在设置窗口中输入“服务”...

阿K1225 ⋅ 今天 ⋅ 0

Elasticsearch 6.3.0 SQL功能使用案例分享

The best elasticsearch highlevel java rest api-----bboss Elasticsearch 6.3.0 官方新推出的SQL检索插件非常不错,本文一个实际案例来介绍其使用方法。 1.代码中的sql检索 @Testpu...

bboss ⋅ 今天 ⋅ 0

informix数据库在linux中的安装以及用java/c/c++访问

一、安装前准备 安装JDK(略) 到IBM官网上下载informix软件:iif.12.10.FC9DE.linux-x86_64.tar放在某个大家都可以访问的目录比如:/mypkg,并解压到该目录下。 我也放到了百度云和天翼云上...

wangxuwei ⋅ 今天 ⋅ 0

PHP语言系统ZBLOG或许无法重现月光博客的闪耀历史[图]

最近在写博客,希望通过自己努力打造一个优秀的教育类主题博客,名动江湖,但是问题来了,现在写博客还有前途吗?面对强大的自媒体站点围剿,还有信心和可能型吗? 至于程序部分,我选择了P...

原创小博客 ⋅ 今天 ⋅ 0

IntelliJ IDEA 2018.1新特性

工欲善其事必先利其器,如果有一款IDE可以让你更高效地专注于开发以及源码阅读,为什么不试一试? 本文转载自:netty技术内幕 3月27日,jetbrains正式发布期待已久的IntelliJ IDEA 2018.1,再...

Romane ⋅ 今天 ⋅ 0

浅谈设计模式之工厂模式

工厂模式(Factory Pattern)是 Java 中最常用的设计模式之一。这种类型的设计模式属于创建型模式,它提供了一种创建对象的最佳方式。 在工厂模式中,我们在创建对象时不会对客户端暴露创建逻...

佛系程序猿灬 ⋅ 今天 ⋅ 0

Dockerfile基础命令总结

FROM 指定使用的基础base image FROM scratch # 制作base image ,不使用任何基础imageFROM centos # 使用base imageFROM ubuntu:14.04 尽量使用官方的base image,为了安全 LABEL 描述作...

ExtreU ⋅ 昨天 ⋅ 0

存储,对比私有云和公有云的不同

导读 说起公共存储,很难不与后网络公司时代的选择性外包联系起来,但尽管如此,它还是具备着简单和固有的可用性。公共存储的名字听起来也缺乏专有性,很像是把东西直接堆放在那里而不会得到...

问题终结者 ⋅ 昨天 ⋅ 0

C++难点解析之const修饰符

C++难点解析之const修饰符 c++ 相比于其他编程语言,可能是最为难掌握,概念最为复杂的。结合自己平时的C++使用经验,这里将会列举出一些常见的难点并给出相应的解释。 const修饰符 const在c...

jackie8tao ⋅ 昨天 ⋅ 0

聊聊spring cloud netflix的HystrixCommands

序 本文主要研究一下spring cloud netflix的HystrixCommands。 maven <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-clo......

go4it ⋅ 昨天 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部