コメントアウト(CommentOut)とは

  • このエントリーをはてなブックマークに追加
  • Pocket
  • LINEで送る
Comment Out (Do Not Run)

 

CommentOut(コメントアウト)とは、作成したプロジェクト内で不要になったアクティビティやシーケンスを実行しないようにできる機能です。
もちろんアクティビティ自体を削除すればアクティビティは実行されませんが、プログラムを作成していると一時的に特定のアクティビティのみ実行したくない、という場合がよくあります。作成したプログラムを削除したくないが実行はしない、といった際にはコメントアウト機能を使用します。

コメントとコメントアウトの違い

コメントは必要な情報を付加するためのアクティビティですが、コメントアウトは不要なアクティビティ等を実行しないようにする機能です。コメント解除を行えば再度同様に動作するため、「また使うかも?」「後で参考にしたいから残しておこう」などというときはコメントアウトしておくとよいと思います。

コメントアウトの使い方

コメントアウトのアクティビティ

アクティビティパネルの検索バーで「Comment Out」と検索することで絞り込んで表示することが可能です。このアクティビティをDesignerパネルへドラッグ&ドロップすることで、「Comment Out」アクティビティと「Ignored Activities」アクティビティが作成されます。「Ignored Activities」にコメントアウトしたいアクティビティを入れることで実行されなくなります。

また特定のアクティビティやシーケンスを選択した状態で、「Ctrl + D」とすることでもコメントアウトされます。(コメントアウトの解除は「Ctrl + E」)
ショートカットキーを利用したほうが効率が上がりますので、ぜひこちらを使用していきましょう。その他のショートカットキーを確認したい場合は、「ショートカットキー一覧」を参照してください。

プロパティ

コメントアウトのプロパティは以下の通りです。

DisplayName:デザイナーパネル上に表示される名称を変更します。日本語も使用可能です。

効果的な使用方法

コメントアウトしたアクティビティは基本的には不要なものです。DisplayNameを「(追って削除)comment out」などとしておくことで、ユニバーサル検索(Ctrl + F)を行った際に一通り検知し削除することが可能です。コメントアウトだけに限りませんが、表示名や変数名は予めルールを決めておき、規則に沿って命名するようにしましょう

コメントアウトとユニバーサル検索の複合

またAnnotations(注釈)と合わせてコメントアウトを使用することで、「なぜこの処理をコメントアウトしているのか」という補足を記載することができます。
注釈機能の詳細については「Annotations(注釈)とは」を確認ください。

コメントアウトのサンプル

一方のメッセージは表示しない。

コメントアウトのサンプル

注釈と合わせて使用し、コメントアウトの意図を説明する。

コメントアウトサンプル2

  • このエントリーをはてなブックマークに追加
  • Pocket
  • LINEで送る

SNSでもご購読できます。

コメントを残す

*