文档章节

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

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

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

niithub
05/01
0
0
使用sphinx快速生成Python API 文档

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

naughty
2015/03/06
0
2
C# WebAPI中使用Swagger

随着互联网技术的发展,现在的网站架构基本都由原来的后端渲染,变成了:前端渲染、先后端分离的形态,而且前端技术和后端技术在各自的道路上越走越远。 前端和后端的唯一联系,变成了API接口...

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

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

sinat_34719507
2017/03/06
0
0
API文档编写工具

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

OpenIoT
2016/07/28
379
0

没有更多内容

加载失败,请刷新页面

加载更多

70.shell的函数 数组 告警系统需求分析

20.16/20.17 shell中的函数 20.18 shell中的数组 20.19 告警系统需求分析 20.16/20.17 shell中的函数: ~1. 函数就是把一段代码整理到了一个小单元中,并给这个小单元起一个名字,当用到这段...

王鑫linux
今天
2
0
分布式框架spring-session实现session一致性使用问题

前言:项目中使用到spring-session来缓存用户信息,保证服务之间session一致性,但是获取session信息为什么不能再服务层获取? 一、spring-session实现session一致性方式 用户每一次请求都会...

WALK_MAN
今天
6
0
C++ yield()与sleep_for()

C++11 标准库提供了yield()和sleep_for()两个方法。 (1)std::this_thread::yield(): 线程调用该方法时,主动让出CPU,并且不参与CPU的本次调度,从而让其他线程有机会运行。在后续的调度周...

yepanl
今天
4
0
Java并发编程实战(chapter_3)(线程池ThreadPoolExecutor源码分析)

这个系列一直没再写,很多原因,中间经历了换工作,熟悉项目,熟悉新团队等等一系列的事情。并发课题对于Java来说是一个又重要又难的一大块,除非气定神闲、精力满满,否则我本身是不敢随便写...

心中的理想乡
今天
42
0
shell学习之获取用户的输入命令read

在运行脚本的时候,命令行参数是可以传入参数,还有就是在脚本运行过程中需要用户输入参数,比如你想要在脚本运行时问个问题,并等待运行脚本的人来回答。bash shell为此提 供了read命令。 ...

woshixin
今天
4
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部