避免错误与好的评论 - 假人

很多人把评论视为浪费时间的练习。但是评论对帮助你记住你为什么以某种方式做了某些事情，避免过去没有奏效的技术而言是非常宝贵的。然而，除了一般文件，评论可以帮助你避免错误。

以下是您从良好评论中获得的一些好处：

• 评论可以记录过去曾经或未曾奏效的技术。

  <！您可以使用注释作为告诉某人脚本，函数或方法的目的的一种手段 - 减少为特定需要使用错误代码的可能性。一个好的评论说明了为什么某些事情是以某种方式完成的，这有助于确保代码更改不会引入错误。

• 完整评论意味着记录输入和输出，以便每个人都知道如何与脚本，功能或方法进行交互。

• <！ - 2 - >

• 知道与某个特定问题联系的人是防止错误的第一道防线，因为发端人通常可以告诉某人如何避免问题。记录代码设计运行的环境有助于您了解何时由其他软件（而不是脚本，函数或方法本身）的更新导致错误。最好的政策是尽可能避免错误。避免错误总是比从错误中恢复成本低。然而，最昂贵的错误是致命的，导致应用程序崩溃。当应用程序崩溃时，人们会丢失数据，组织会丢失客户正确的文档可以帮助人们更好地理解你的代码，避免错误发生之前（或者甚至在有人可以想出一个错误的方法之前）。

• 世界上最好的评论不能防止所有的错误。一些错误简单地发生，而且你无能为力。例如，您无法避免由于雷击（由电流引入网络连接引起的数据错误）而导致的错误。有时，MATLAB用来执行任务的硬件故障和第三方软件也可能包含错误。许多错误来源不受您的控制，但有效地使用注释可帮助您减少可以控制的错误数量。