本当に優れたコードにはアノテーションを付ける必要があります。コメントは、後でこのコードを読む人に、この行が何をしているのか、なぜこのように書かれているのかを伝えるために、ソース コードの横に書き込まれます。 ArkTS には、単一行と複数行の 2 種類のコメントがあります。説明を適切な場所に入力すると、このコードは将来の変更の基礎となります。
サポートビデオは「8. 保守が容易な優れたコードを作成するための単一行コメントと複数行コメント」にあります。
一行コメント
単一行コメントは次で始まります // 最初は、現在の行のみがカバーされます。 2 つのスラッシュから始まり行末までがコメントです。次の行に移動すると、再びコードになります。コメントはコード行の上または最後に記述できます。上で記述した場合、指示は別の行を占める必要があります。まずインテントを完成させてからステートメントを書きます。
// 这是一行注释
console.log('Hello ArkTS');
console.log(userName); // 这是行尾注释
このコメント行はそのすぐ隣の文についてのみ説明しています console.log: Hello ArkTS という文字列をログに書き込みます。コードの終わりには行末コメントが続きます。この文には説明が付けられており、特に短い補足に適しています。一文で言えれば一行コメントでも十分です。
上の行は、コードの読者に次の文が出力されることを伝えます。行末の行は、この文がユーザー名を出力することをコードの読者に伝えます。
複数行のコメント
命令を多くの行で記述する必要がある場合は、複数行のコメントに置き換えてください。それはから始まります /* から始まる */ 最後に、自由に改行できます。それに含まれるすべての行がコメントです。複数行のコメントは、段落全体を一度に記述するのに適しています。
/* 这是一段多行注释 可以写很多行说明 */ console.log('count:', 666);
console.log 複数のパラメータを一度に取得できます。出力時、デフォルトではパラメータはスペースで区切られます。'count:' そして 666 それを入力するだけです count: 666。このような複数の文で説明する必要があるルールをペアで入れます。 /* そして */ 真ん中。複数行のコメントはネストできません。コンパイラは読み取ります /*ここからのテキストは、後で表示される最初のテキストまで無視してください。 */。コメントにまた出てきます /*この説明では単なる普通のテキストです。
/* 这是一段多行注释 可以写很多行说明 /* 嵌套 */ */ console.log('count:', 666);
内層 /* 嵌套 */ 中のもの */コメント全体を締めくくりました。最後の行だけ */ コメントの範囲外にある場合、コンパイラーはそれをコードとして扱い、このセクションはコンパイルされません。段落ごとに 1 つのペアのみを使用する /* そして */。
3つの書き方をまとめると
同じコード部分にコメントを追加するには、次の順序に従います。まずコードの上に 1 行のコメントを記述し、次に別の行の末尾に行末コメントを追加し、最後に複数行のコメントを使用して出力ルールを明確に記述します。
// 打印字符串 console.log('Hello ArkTS'); console.log(userName); // 打印用户名 /* 打印多个参数 输出：默认用空格自动分隔 */ console.log('count:', 666);
コメントを使用したデバッグ
アノテーションには、デバッグという別の即時オプションもあります。特定の行でエラーが報告された場合、または現時点ではその行を実行したくない場合は、最初にソース コードを保持し、次のコードを追加します。 //この行はスキップされます。変更後は削除してください //コードはまだそこにあります。エディターでこの行を選択し、Ctrl + / を押してコメントを追加し、もう一度 Ctrl + / を押してキャンセルします。まずユーザー名を出力する行をブロックすると、ファイルは次のようになります。
// 打印字符串 console.log('Hello ArkTS'); // console.log(userName); // 打印用户名 /* 打印多个参数 输出：默认用空格自动分隔 */ console.log('count:', 666);
Ctrl + S を押して保存します。保存後、まだ実行中の 2 つの文がログに出力されます。1 行は Hello ArkTS他の行は count: 666。真ん中の文はすでにコメントになっているため、コンパイラはそれをスキップします。
コンパイラはコメントをスキップします
コメントは開発者向けに書かれています。コンパイラは、ソース コードを処理するときにこれらの単語を自動的に無視し、実行するステップに変換せず、プログラムの実行結果は変更されません。一文でわかるならそのまま使ってください //。ルールのセクション全体を残すには、次を使用します。 /* そして */。デバッグするときは、最初にコメントしてから復元してください。将来このコードを変更する人が直接理解できるように、説明を残しておきます。
