lin-cms-koa icon indicating copy to clipboard operation
lin-cms-koa copied to clipboard

关于文档的完善

Open GuodongH opened this issue 6 years ago • 2 comments

CMS系统中,并没有实现API DOC,是否可以考虑增加这一特性,例如引入apidoc这一模块,在代码中增加相应注释,使得自动生成各类文档,以方便后续开发? 因为现阶段,项目整体还不算复杂,现在添加这一feature,工作量还不算大,而且文档齐备会对新手更加友好,谢谢。

GuodongH avatar Sep 06 '19 12:09 GuodongH

对于业务性的项目, 肯定存在业务更改,不过良好的注释肯定会优化的,谢谢意见

pedrogao avatar Oct 25 '19 08:10 pedrogao

import { LinRouter } from 'lin-mizar'; lin-mizar 这个包暴露的方法 接口 有文档吗?

william-xue avatar May 25 '21 05:05 william-xue