开源改变世界

低于标准的代码注释 Grbl-Hal 部分 #11

推推 grbl 3年前 (2023-02-08) 184次浏览
打开
AnthonyJQQ 开启了这个issue 2021 年 7 月 28 日 · 3条评论
打开

低于标准的代码注释 Grbl-Hal 部分#11

AnthonyJQQ 开启了这个issue 2021 年 7 月 28 日 · 3条评论

评论

低于标准的代码注释 Grbl-Hal 部分 #11

我对代码缺少注释感到有些失望。具体与 GrblHAL 驱动程序相关。我喜欢 Grbl 的原因之一是代码注释非常好,这使得在现有 CNC 机器上配置和实施变得容易。

GrblHAL代码应该有类似GRBL的注释,但是代码的GRBLHAL组件缺少解释。
例如,昨晚我花了一些时间试图了解编码器插件中编码器开关的作用,但是代码注释太少,以至于我无法快速轻松地理解编码器插件和插件中的功能是如何工作的。

我决定发布此问题以标记所有从事 GrblHAL 工作的人记住正确注释您的代码,以便我们可以更好地了解如何使用 GrblHAL 并将其应用于我们的真实机器。代码应该在每个函数之前有注释来解释函数的作用,以及添加到页面顶部的注释来解释整个代码应该做什么。

为什么我感到失望:
我决定使用 Phil Barrett 的GrblHal Teensy 分线板将 CNC 移动到 GrblHAL该机器最初是基于https://github.com/bdurbrow/grbl-Mega运行的。grbl-Mega 项目中的代码具有与 GrblHal 中的驱动程序功能相似的功能,但它的注释要好得多,因此在现实世界中更容易实现。在我的情况下,使用带有良好注释代码的旧硬件可能比使用最新的软件/硬件 (GrblHAL) 更好,因为缺少代码注释。我希望 GrblHAL 代码发展到像 Grbl 本身一样出色和易于使用的程度!

@terjeio对我放轻松。;)

谢谢!

低于标准的代码注释 Grbl-Hal 部分 #11
贡献者

很抱歉浪费了您宝贵的时间。

还有很多工作要做——而且我根本没有时间从一开始就让一切都变得完美。有时我希望自己保留代码,因为让项目继续进行需要花费大量时间。

我最近开始使用 doxygen 添加文档以使其更易于访问,但这需要一些时间才能完成。Wiki 也应该扩展……

最后,我很高兴听到 grbl-Mega 项目非常适合您的需求——有可用的替代方案真是太好了。

低于标准的代码注释 Grbl-Hal 部分 #11
贡献者
安德鲁马尔斯 评论了 2021 年 7 月 28 日  

我真的很想在这里保持积极的态度,但我决定发表评论,因为我认为这个“问题”毫无成效。每个人都应该记住,GRBLHAL 是免费和开源的,它就是你的作品。如果你看到你想做的事情,你应该努力让它发生。也许你应该花一点时间来理解代码,然后做一个 pull request 来添加一些评论,或者甚至只是在 wiki 或插件的自述文件中添加一些东西,或者在你的博客上发表一篇关于你的经验的文章,这样其他人可以学习……您可以通过多种方式做出实际有意义的贡献。

感谢 Terje 为这个项目(以及你的其他项目)所做的一切,这都是令人惊叹的工作,也是开源社区的灵感来源。

低于标准的代码注释 Grbl-Hal 部分 #11
作者

@terjeio谢谢你的链接。随着我继续理解代码,我将添加一些带有注释的拉取请求。

请不要以错误的方式看待这个问题,我认为你在这里所做的是惊人的,我很高兴能为这个项目做出贡献。与 doxygen 的链接很棒。

@andrewmarles注释不佳的代码是我书中的一个问题。我同意你的观点,拉取请求是一种很好的贡献方式,但它们不会提醒问题。

我想把它作为一个问题专门提出来。这是项目中绝对需要改进的东西,所有开发人员和贡献者在处理他们的拉取请求时都应该考虑它。

免费注册 在 GitHub 上加入此对话。已有帐户? 登录评论
标签
还没有
项目

还没有

发展

没有分支机构或拉取请求

3人参加
低于标准的代码注释 Grbl-Hal 部分 #11低于标准的代码注释 Grbl-Hal 部分 #11低于标准的代码注释 Grbl-Hal 部分 #11

喜欢 (0)