History: DevCoding - AIDMix - AIDMix

コーディング

---

Outline

• コメント
  • 拡張ポイント
  • エラーコメント
  • 通常コメント

---

コメント

拡張ポイント

冗長的にモジュールを追加するような箇所に記述するコメントのことを指します。

• 1行の場合の記述方法 Expand: xxxx
• *複数行の場合の記述方法* _*Expand:*_ xxxx

xxxx

• *ex.*

  int func(void)
  {
      ...
      /* --- Expand: ここにモジュールを追加してください --- */
      binder += Core::InstancePtr();
      binder += Process::InstancePtr();
      ...
  }
  

      ...
      /* ========================================================================
          Expand: ここにメインモジュールを追加してください。
      ======================================================================== */
      (*this) += Process::InstancePtr();
      (*this) += Device::InstancePtr();
      ...
  

エラーコメント

エラーとして処理される箇所に記述するコメントのことを指します。

• *記述方法* _*Error:*_ xxxx
• *ex.*

  void func(Object *obj)
  {
      if (!obj) {
          /* --- Error: 無効なオブジェクトです。 --- */
          return;
      }
  }
  

通常コメント

クラスや関数以外で記述するコードに対するコメント