文档章节

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

找个没人用的名字
 找个没人用的名字
发布于 2016/04/12 10:36
字数 192
阅读 79
收藏 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
0
2
RESTFul接口测试工具:Wisdom RESTClient

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

niithub
05/01
0
0
Wisdom RESTClient 1.2 发布,支持生成REST API文档

Wisdom RESTClient 1.2 发布了,支持生成REST API文档,同时也修复了一下问题和功能增强。 本次更新内容如下: 1. 支持生成REST API文档; 2. 支持对历史记录进行可视化编辑来满足实际测试和...

码翼
11/03
730
0
自动化测试 REST API 的工具 - Wisdom REST Client

Wisdom rest-client 一款自动化测试 REST API 的工具,它可以自动化测试 REST API 并生成精美的测试报告,同时基于测试过的历史数据,可以生成精美的 REST API 文档。 下载JAR包; 使用前请先...

domwang
11/02
0
0
使用API自动生成工具优化前端工作流

在工作中,我们的前端工作流一般开始于前后端协商好Api文档之后,再针对这个Api文档做mock模拟数据,然后用做好的mock进行开发,后端开发完毕之后再改一下API数据的BaseURL切换到正式API进行...

SHERlocked93
12/06
0
0

没有更多内容

加载失败,请刷新页面

加载更多

Ugly Number(leetcode263)

Write a program to check whether a given number is an ugly number. Ugly numbers are positive numbers whose prime factors only include 2, 3, 5. Example 1: Input: 6Output: true......

woshixin
16分钟前
0
0
深度模型从研者 眼里的 似然估计 & Hessain 海森矩阵 & Fisher Information (费雪信息)

深度模型的训练的基本依据是最小化模型拟合数据的误差。旨在不仅知其然(如何构建和训练一个深度模型),还应知其所以然(为什么这样训练,可以做哪些优化)。我们就会发现,有很多研究者,在...

刘小米_思聪
20分钟前
0
0
阿里巴巴智能监控新场景的探索

摘要: 智能监控是智能运维的子领域,详细分析。 作者简介 王肇刚 阿里巴巴全球运行指挥中心高级技术专家 智能监控是智能运维的子领域,我们说的监控,探讨的更多是在监控策略,因为可能从数...

阿里云官方博客
22分钟前
1
0
【双十二】12 月 12 日 12 点 12 分限量抢福利,云计算不剁手!

活动详情 1.首充豪礼 双十二当日,新用户首充 200 元送 200 元代金券!仅限前 88 名!先到先得!拼手速!(新用户指 12 月 12 日前已完成注册但从未充值过的用户)
 2.超值返券 双十二当日,...

七牛云
48分钟前
3
0
Calculate Linux 发布 18 LXQt是基于Gentoo的发行版

导读 Calculate Linux 是一个基于 Gentoo 并与 Gentoo 完全兼容的滚动更新发行版家族,专为企业环境下的快速部署而优化。其提供多个不同的分支版本,分别适用于桌面、服务器等应用场景。该项...

问题终结者
50分钟前
2
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部