Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

关于文档的完善 #37

Open
GuodongH opened this issue Sep 6, 2019 · 2 comments
Open

关于文档的完善 #37

GuodongH opened this issue Sep 6, 2019 · 2 comments

Comments

@GuodongH
Copy link

GuodongH commented Sep 6, 2019

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

@pedrogao
Copy link
Collaborator

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

@william-xue
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants