source code document
来源:互联网 发布:单片机报警电路设计 编辑:程序博客网 时间:2024/06/06 03:51
It’s always good to write source code document. As it’s said better written than remember nothing.
Recently, I was involved in one js project. And the project contains basic control and app develop framework. So it’s a must to have clearlly wirten APIs.
We choose js doc as the tools.
First, install the tools
sudo npm install git+https://github.com/jsdoc3/jsdoc.gitsudo npm install ink-docstrap
Secondly, setup configuration.json file
Finally, run
jsdoc -c ./configuration.json -t $TemplatePath -d ./docstrap_doc
where $TemplatePath, is node_modules/ink-docstrap/template
After that, you have got bunches of .xml files. And you can put in in some website. They are static web sites.
阅读全文
0 0
- source code document
- source code
- source code
- source code
- source code
- Source Code of exe2com.
- Source Code of exe2com
- HookAPI source code
- Source code of CIH
- Microsoft CLI source code
- PHPfileNavigator source code
- Linux source code
- about packer source code
- Source Code Search Engine?
- source code generators.
- [Source Code]文件过滤
- Source Code Comprehension Tools
- DES JAVA source code
- 语言小知识-python-os 操作获取文件夹里的每个文件的路径并进行读取
- zoj3870-Team Formation(异或运算+数学规律)
- 见微知著----POJ2352(树状数组 或 线段树)
- Intellij idea史上最简单的教程之Linux下安装与破解Intellij idea2017
- 某小型公司持续集成工具jenkins实践(JAVA WEB、Android、IOS、Html)
- source code document
- 求二叉树满足条件路径
- 阿里笔试第一题
- 三维数组初始化(一次for循环)
- zzuli 2183 就是签到题XD【分段打表】
- tcpdump参数解析及使用详解
- 阿里2018校招笔试编程题
- 前端开发环境搭建及上传至github
- Linux必杀(十八):VI、VIM编辑器