YUIDoc的使用方法小结

简介:

一.YUIDoc概述以及安装
YUIDoc是为YUI Library用来生成HTML版API文档的一系列工具集,文档的生成完全基于JavaDoc风格的代码注释规则。该工具是基于Python语言编写,并且使用了几个基于Python的扩展组件作为底层支持,如读写json对象、HTML模板管理以及源代码着色等等。所以在使用YUIDoc之前,请确保你的机器上已经安装了Python环境和YUIDoc所依赖的Python扩展组件,详述如下:

  • Python 2.3+ 
  • simplejson - 提供读写json对象支持(Python扩展)
  • cheetah     - 为生成HTML文档提供模板支持(Python扩展)
  • pygments  - 源代码着色工具(Python扩展)

(tips: 如果你对Python语言不熟,那也没有关系,python扩展的安装方法是非常简单的。如果是Windows环境,首先为Python设置一下环境变量Path,即向环境变量Path上追加C:\Python26,也就是Python默认的安装路径;接下来解压每一个扩展组件,在文件夹中你会发现一个setup.py的文件,运行DOS,切换到解压后的目录下(或者setup.py所在的目录下),输入python setup.py install即可搞定大多数扩展组件的安装:P)
不过,安装simplejson的时候会有一点点小麻烦,即该扩展库依赖于另一个python扩展setuptools,下载完组件的egg文件(我下载的叫setuptools-0.6c7-py2.6.egg)后直接放到simplejson的setup.py同一路径下,按照上面介绍的命令再次运行setup.py,安装成功。
二. YUIDoc的简单使用方法
使用命令:yuidoc.py inputdir [options] inputdir
(其中options可以通过以下命令来获取帮助:yuidoc.py --help)
这里有以下几点需要注意

  • 可选参数和跟在后面的输入目录(inputdir)是成对出现的,如设置文档输出路径 -o E:\outputs
  • 可选参数“模板路径”一定要给定,经测试,如不给定模板路径,文档生成失败(引发WindowError)

所以最后的参考使用命令为:
python yuidoc.py E:\libdir -t E:\template -o E:\outputs
其中,
E:\libdir路径存放所有的具有良好注释的JavaScript文件,yuidoc会搜索该目录下的所有JavaScript文件
E:\template路径存放HTML模板,具体请参考yuidoc目录下的template文件夹
E:\outputs路径是yuidoc将生成完的HTML帮助文档存放的路径
好了,所有的安装和基本使用方法就是这些。如果你的JavaScript文档符合yuidoc所规定的注释规范,并且命令执书写正确,那么正确的JavaScript文档就会出现在你眼前!
Enjoy!!!

目录
相关文章
|
10月前
|
NoSQL Linux Android开发
OPENJTAG调试学习(三):使用 gdb 命令行进行调试
OPENJTAG调试学习(三):使用 gdb 命令行进行调试
141 0
|
数据库
什么是数据库的三大范式(浅显易懂)
<p><br></p> <p><br></p> <p></p> <p style="margin-top:10px; margin-bottom:10px; padding-top:0px; padding-bottom:0px; color:rgb(51,51,51); text-indent:28px; font-family:宋体; font-size:14px; line-h
3203 0
|
存储 算法 安全
SHA-1被攻破了吗? PostgreSQL SCRAM-SHA-256 安全认证机制解救你来了
标签 PostgreSQL , 认证方法 , SCRAM-SHA-256 , scram , scram-sha-256-plus , SASL , Simple Authentication and Security Layer 背景 PostgreSQL的很多设计非常的工业化,比如开放了许多扩展接口(类型、操作符、索引、扫描、采样、数据库编程语言等)。
6939 0
|
Linux
linux下串口编程设置函数---------set_opt(fd1,115200,8,&#39;N&#39;1)--------------------
<p>open /dev/ttys0, 设备文件之后,得到文件描述符, 对串口进行设置。</p> <p></p> <pre code_snippet_id="261621" snippet_file_name="blog_20140328_1_1409127" name="code" class="objc">/** *串口设置函数:例(fd1, 115200, 8, 'N', 1);
3396 0
|
机器学习/深度学习 人工智能 算法
线性规划之单纯形法【超详解+图解】
1.作用     单纯形法是解决线性规划问题的一个有效的算法。线性规划就是在一组线性约束条件下,求解目标函数最优解的问题。 2.线性规划的一般形式     在约束条件下,寻找目标函数z的最大值。
3865 0
《分布式系统:概念与设计》一2.3 体系结构模型
本节书摘来华章计算机《分布式系统:概念与设计》一书中的第2章 ,第2.3节,(英) George Coulouris Jean DollimoreTim Kindberg Gordon Blair 著 金蓓弘 马应龙 等译 更多章节内容可以访问云栖社区“华章计算机”公众号查看。
1645 0
时钟周期 指令周期 机器周期的理解
     时钟周期:时钟周期也称为振荡周期,定义为时钟脉冲频率的倒数(时钟周期就是单片机外接晶振的倒数,例如12M的晶振,它的时钟周期就是1/12us),是计算机中的最基本的、最小的时间单位,也即CPU主频。
1645 0
|
SQL MySQL 关系型数据库
Mysql:查询每个月下的数据,根据状态或者年份的sql语句
     ------------吾亦无他,唯手熟尔,谦卑若愚,好学若饥-------------       本次的MySQL开篇记录了一道面试题,我给其扩展一下     这面试题它难点在什么地方,不外乎是操作月份和将其展示的格式问题,他要查每个月份下的状态,并将其横向展示     给本次博客列一个篇章,我要讲什么: 1.
2189 0