
文档编写
文章平均质量分 85
千里小芝麻
千里之行始于足下,忘我如芝麻!
展开
-
利用apidoc在注释里写API文档
本文基于node.js的代码注释编写。程序员都不喜欢写文档,但是程序员习惯写注释。所以今天给大家安利一个注释文档的工具——apidoc,一个在注释里边编写API文档的小工具!由于经验以及英文水平问题,文中很有可能会有错漏,各位大神如果看出来了,麻烦指出一下。谢谢~安装apidocnpm install -g apidoc运行apidoc -i myapp/ -o ...转载 2018-10-31 20:30:57 · 592 阅读 · 0 评论 -
如何优雅的书写接口文档?学会Markdown就够了
Markdown 是一种「电子邮件」风格的「标记语言」,我们强烈推荐所有写作者学习和掌握该语言。为什么?可以参考:『为什么作家应该用 Markdown 保存自己的文稿』。 『Markdown写作浅谈』在此,我们总结 Markdown 的优点如下:纯文本,所以兼容性极强,可以用所有文本编辑器打开。 让你专注于文字而不是排版。 格式转换方便,Markdown 的文本你可以轻松转换为 h...转载 2018-10-30 09:53:41 · 3075 阅读 · 1 评论