開発者の生活にコメントは欠かせません。新しい機能に取り組むとき、私たちはしばしば備忘録のようなコメントを付けます。例えば
- コードの一部を同僚と検証するために
- 関数をリファクタリングするため。
- パフォーマンスを低下させているコードを修正するため。
- メソッドやクラスをセクションに分割するため。
- クラスのスケルトンを作成し、各関数の内部にTodoコメントを追加する。
たとえ簡単なコードを書いたとしても、数カ月後、数年後に読んでみてください。まだシンプルに見えるでしょうか、それともコメントを付けておけばよかったと思うでしょうか。
4D v19 R4では、コメントをより整理するために、コメントタグを 使用することで、全く新しいレベルのコメントを提供します。
新しいタグは3つあります。
- MARK
- TODO
- FIXME
この前のブログ記事で、コード・エディタのリストを紹介し、クラス内を簡単に移動できるようにしました。これらの3つのタグで始まるコメントも、このリストに表示されます。
これらのタグは、クラスやメソッド内で使用することができます。
使用方法
MARK タグを使用すると、コードをセクションに分割することができます。3 種類の書き方ができます。他の 2 つのタグ、TODO と FIXME も同じように書きます。利点は、リスト内のアイコンが異なることで、今後のアクションの優先順位をつけるためにコードを整理することができます。
- //MARK:私のコメント: セクションを追加する
- //MARK:- my comment with the line: セパレーターラインを使ったセクションを追加する
- //MARK:-：セパレータ行だけを追加するには
- //TODO: これを行うには
- //FIXME:これを修正する
ORDA クラスの例です。
関数とコメントタグは、クラスとメソッドの内部で出現順に表示されます。お好みで、macOSではCmd、WindowsではAltを押したままメニューを展開すると、クラスの関数やコメントタグをアルファベット順に表示させることができます。
次は何をする？
この新機能を使って、コーディングのゲームをステップアップする準備はできましたか？コードを整理し、クラスやメソッドをナビゲートするためのこの新しい可能性についてどう思うか、私たちに教えてください。フォーラムでお待ちしています。