改善工具箱之前出版/最佳实践

1视图(30天)
弗雷德里克”class=
弗雷德里克 2018年2月6日
评论道: 亚当Danz 2019年10月27日
我有一个收集的功能和Simulink-Models帮助其他研究人员在这个领万博1manbetx域值得出版。然而这些文件的质量各不相同,我想让他们准备好别人。有收藏的“最佳实践”或某种清单在发表前寻找什么?
我已经做了什么:
我想要得到更多关于这个主题的想法和提示。
弗雷德里克

答案(2)

图像分析”class=
图像分析 2018年2月6日
评论的数量和你的源代码 认为 你所需要的。
从来没有人抱怨 太多的 解释性语句嵌入到源代码中。越多越好。有时(后来)即使我慢慢的看 我自己的 代码,我很难理解如果我没有注释来解释它。
我将一个计数器程序我写评论。相比之下,35%的我的代码行
1评论
亚当Danz”class=
亚当Danz 2019年10月27日
+ 1
这个函数应该在文件交换!
从来没有人抱怨太多的解释性语句
我被洪水文件评论包括详细描述,行内注释整个代码,最后脚注的列表。结果是一个简单的行函数变成50行,有时我问自己它太多但我想象有一天我或其他人将受益于知道的背景决定在写代码。

登录置评。


史蒂文的主”class=
史蒂文的主 2018年2月6日
考虑写一些基本 测试 为你的功能。
不要担心这个页面出现在“高级软件开发”部分的文档。 基于脚本的测试 很容易写,只要你知道如何编写代码部分(从% %)和使用 断言函数
基于函数的和基于类的测试提供额外的功能(例如更高级的设置和清除功能)的成本更多的复杂性。但哪怕是最基本的基于脚本的测试可以证明宝贵的用户开始修改你的功能。他们的失败将(或应该)提醒用户,当他们的预期行为变化的影响函数的方式他们没想到。
1评论
亚当Danz”class=
亚当Danz 2019年10月27日
+ 1另一个伟大的想法,应该更常用的!

登录置评。

社区寻宝

找到宝藏在MATLAB中央,发现社区如何帮助你!

开始狩猎!