良いコメントでエラーを避ける - ダミー

多くの人々が時間を無駄にするように練習としてコメントを却下します。しかし、コメントは、あなたが何らかの理由で何をしたのかを覚えて、過去に働いていなかったテクニックを避けるために、実際には非常に貴重です。しかし、一般的なドキュメント以外にも、コメントは間違いを避けるのに役立ちます。

コメントには、以下のような利点があります。

• コメントには過去に働いていた技術やできなかった技術が記録されています。

  <！ - 1 - >

• コメントは、スクリプト、関数、またはメソッドの目的を誰かに伝えるための手段として使用でき、特定のニーズに間違ったコードを使用する可能性を低減します。

• 良いコメントは何かが何らかの形で行われた理由を示しています。これはコードの変更によってエラーが発生しないようにするのに役立ちます。

• 完全なコメントとは、誰もがスクリプト、関数、またはメソッドと対話する方法を知るように、入力と出力を文書化することを意味します。

  <！ - 2 - >

• 特定の問題に関する連絡先を知ることは、エラーに対する防衛の第一線であり、発信者は通常、問題を回避する方法を誰かに伝えることができるからです。

• コードが動作するように設計された環境を文書化すると、スクリプト、関数、またはメソッド自体ではなく、他のソフトウェアの更新によってエラーが発生したときを理解するのに役立ちます。

可能な限り、エラーを避けることが最善の方針です。エラーを避けることは、エラーからの回復よりもコストがかかりません。しかし、すべての中で最もコストのかかるエラーは、致命的なものであり、アプリケーションをクラッシュさせるものです。アプリケーションがクラッシュすると、人々はデータを失い、組織は顧客を失います。適切なドキュメントは、人々があなたのコードをよりよく理解し、起こる前に（または誰かが最初にエラーを起こす方法を考える前に）間違いを避けるのに役立ちます。

<！ - 3 - >

世界で最も良いコメントは、すべてのエラーを防ぐことはできません。何らかのエラーが起こるだけで、あなたができることは何もありません。たとえば、落雷の結果として発生するエラー（ネットワーク接続に誘導される電流によってデータエラーが発生する）を回避することはできません。場合によっては、MATLABがタスクを実行するために使用するハードウェアのグリッチやサードパーティのソフトウェアにもエラーが含まれることがあります。多くのエラーの原因はコントロールの外にありますが、コメントを使用すると効果的にエラーを減らすことができます。