Codo - Coffeescript的文档生成工具

发布于 11 年前作者 think2011 4183 次浏览最后一次编辑是 9 年前来自分享

CODO

概述

Codo就是相对javascript的jsdoc,codo是coffeescript的文档生成工具。(真绕口...)
以前并没有太在意文档,随着能力提升,发现开发文档是有多么的重要,真的很重要!
那么介绍就到这里吧!

例子

# 这是一个用来造人的类
# 
# [@example](/user/example) 演示怎么造一个人
# 	jason = new Human 'jason', '男'
#
# [@todo](/user/todo) 下次进化就增加更多的实例方法
# 
class Human 
 # 默认有头
 [@head](/user/head) = true
 # 默认有身体
 [@body](/user/body) = true
 # 默认有四肢
 [@limbs](/user/limbs) = true
 # 构造一个人出来
 #
 # [@param](/user/param) name [String] 姓名
 # [@param](/user/param) sex [String] 性别
 # [@param](/user/param) birthDate [Date] 生日
 #
 constructor: ([@name](/user/name), [@sex](/user/sex), [@birthDate](/user/birthDate) = Date.now()) ->
 
 # 会说话
 #
 # [@example](/user/example) 默认说中文
 # jason.talk '大家好,我是jason,我中国人,中文名?我没有哦!'
 #
 # [@param](/user/param) word [String] 要说的话
 # [@param](/user/param) language [Object] 语言
 # [@option](/user/option) language [String] country 国家
 # [@option](/user/option) language [String] localism 口音
 # [@return](/user/return) [String] word
 #
 talk: (word, language = {country: 'cn', localism: 'normal'}) ->
 	return word