书评:MATLAB风格的元素

发布的罗兰美国舒尔,2011年2月10日

(30天)| 27日视图0喜欢|7评论

我最近被提供了一个机会来评论一本新书,MATLAB风格的元素FEX由贡献者,理查德·k·约翰逊。这是一个很好的机会让我看到什么是重要的在一个特定的眼睛多产的MATLAB用户。,这是一本值得你调查的问题风格,特别是如果你在一个团体或组织工作哪里有很多共享代码和很多人看和使用的代码。

我喜欢理查德的书的第一件事是意图,使它的古老的传统的参考风格的要素,斯特伦克和白色。如果你写英文,我强烈推荐这本书。没有书是全面的,而是试图思想归结为最大的回报和那些经常犯的错误。你得到一些必需品和陷阱,约定(一些,但不是全部,特定的MATLAB)。

看看目录,我们先看一些高水平的原则,其次是少量的主要议题:

格式化
命名
文档
编程
文件和组织
发展

它们一些有用的列表(例如,关键字)。

这些章节最后总结部分将各个部分的主题。这些总结作为一个有用的评论,当你想回到寻找更多的信息。如果是上市,可以肯定的是会有一些项目章指导你。

我不同意每个选择理查德作出了约定,如布局或格式化。MathWorks也不遵循这些(或所有的任何约定,在某些情况下)。我同意他确认相关主题值得任何群体着手讨论项目和规范。

我现在想花一点时间提到许多点的几本书,对我产生共鸣。这些只是一个抽样,所以什么都不读到那些我没有列在这里!

# 7分长代码行优雅点——我觉得这是一个有用的,因为它是一个总疼痛不得不跟踪遥远的权利在任何编辑器中,即使它是可能的。
# 10不要使用硬标签吗——这有助于保持理智,当工作在一组可能不同的编辑环境。
# 43使用有意义的名称为变量有一个很大的范围——这使得代码更容易阅读,理解,和调试,如果必要的。
# 69名称的功能——因为函数执行一个动作,这个名字应该包括关于行动的信息。
# 86在数据Filesnames使用合适的编号——如果你有许多类似文件的数据,有一个合理的编号方案只能帮助你。
# 97确保评论同意代码——我永远都不会忘记,我的导师给我打电话,因为他很生气。我已经离开他的副本一个Fortran程序,丰富的评论,最后一个是“忽略所有上面的评论;他们先前版本。”
# 135避免神秘代码——我发现,一般来说,编写的代码买不到我期待的好东西,比它认股权证和头痛。有时,我用神秘的性能在一些严格时间要求的代码。当我做的时候,我试图充分发表评论,在评论中包括一个直接实现我测试。这样,当性能权衡变化,我理解的代码应该做什么和有两个选项进行代码更新开始。
# 150,151减少全局变量的使用和减少全局变量的使用——我认为这更强烈。有优越的技术来处理信息你想分享,无论是处理函数,类和它们的属性,或者其他方法。这些技术更安全使用的原因很多,例如,更容易控制副作用,应任何不足之处,和代码成为可能更适合并行性。
# 172使用括号——清晰的意义是至关重要的,特别是如果其他人需要理解,修改或翻译的代码。
# 176避免使用eval在可能的情况下——我确信它不会显得那么一些MATLAB用户,但是eval是可以避免的大多数的时间。
# 185 - 188第一个避免复杂条件表达式——这些条目包含一些有用的想法处理条件结构情况下的顺序等。
# 271 - 275第一个编写小测试——我爱理查德已经测试一个这种风格指南的核心原则。我不知道程序员函数没有一个健壮的测试套件。