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.

Sign up for GitHub

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

寻找一种文档笔记的方式 #2

Open

1T16 opened this issue Feb 27, 2019 · 0 comments

1T16 commented Feb 27, 2019 •

edited by abangcc

Loading

记笔记跟demo代码在一个地方完成。
写的时候呢，可以顺便代码是可以执行的。因为要快速的写测试修改测试。
以后看的时候呢，就可以像是网页文档，笔记说明更加重要，代码便是静态的参考。

解决方案：

可以是jupyter那种形式的。这种的优势是，成熟、支持多种语言。。
写在js文件中，笔记写在注释中，用标准的格式，然后用工具生成文档

abangcc closed this as completed

abangcc reopened this

abangcc changed the title ~~Another issue~~ 寻找一种文档笔记的方式

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment