升级程序,请阅读 jsdoc到markdown 从注释的源代码生成markdown API文档。 对于将API文档注入项目自述文件很有用。 概要 1.使用有效的jsdoc注释记录代码。 /** * A quite wonderful function. * @param { object } - Privacy gown * @param { object } - Security * @returns { survival } */ function protection ( cloak , dagger ) { } 2.运行命令。 $ jsdoc2md example.j