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

  • 相关阅读:
    Caused by: org.gradle.api.internal.plugins.PluginApplicationException: Failed to apply plugin[id:xxx.xxx.xxx]
    Caused by: org.gradle.api.internal.artifacts.ivyservice.DefaultLenientConfiguration$ArtifactResolveException: Could not resolve all files for configuration ':classpath'.
    react native 使用typescript
    electron 关于jquery不可以用
    css 你真的了解padding吗?
    css padding-right没有用?
    部署iis7和vs2010低版本项目遇到的一些问题
    html 渲染原理
    webpack 打包jquery
    Java——运算符那些事
  • 原文地址:https://www.cnblogs.com/xumaojun/p/8528928.html
Copyright © 2020-2023  润新知