评论
.png "API文档策略 #630"){kind=avatar}
贡献者
|
我们非常欢迎您提供任何文档！ 我建议使用 github wiki 页面而不是 cncjs.org，因为该 wiki 比 cncjs.org 维护得更积极。 @cheton将不得不权衡代码库中有关 JSDoc 的问题。 |
.png "API文档策略 #630"){kind=avatar}
作者
|
好的。我将首先将生成的 markdown 直接贡献到 wiki 中。我仍在考虑为文档构建基础架构，但这可能会在另一个分支和稍后的拉取请求中结束。 |
作者
|
我决定手动编写文档比在代码库中使用 JSDoc 注释更有意义。这解决了有关代码库中的文档和构建基础结构的问题，因此我将关闭该问题。 |
描述
你好！我使用 cncjs 作为自定义 CNC 机器界面的基础，因此我需要掌握项目中的各种 API。为了保留供以后使用的参考，我认为贡献一些 API 文档是值得的。此刻的我
这听起来是个好计划吗？
我想到 cncjs.org 存储库上的一个问题将是讨论对该存储库的贡献的地方，但我认为首先在这里检查是值得的，cncjs 的维护者如何看待 JSDoc 注释代码库？他们会受欢迎吗？有首选策略吗？
谢谢！