用jsdoc3自动生成JS API文档

简介

  • jsdoc是一款自动产生JS文档的工具。
  • 你得按照它的注释规范来写代码注释,才能够生成合适的文档。
  • 我曾经写过各种风格的混乱注释,用一个个文本来存放管理我的代码库,当我不想再写某段重复难懂的代码的时候,我不得不在我的代码库里游来游去,好头疼啊!!它救了我!!

预览

  • 它可以根据你写的代码自动生成这样的文档出来,看这里
  • 能够搜索,有详细的注释,保存了完整的代码… 很方便,是不是!
  • 接下来就动手吧!

阅读全文