ホームページ >よくある問題 >コードコメントを追加するにはどうすればよいですか?

コードコメントを追加するにはどうすればよいですか?

青灯夜游
青灯夜游オリジナル
2019-04-19 11:04:5217711ブラウズ

次のコードを渡すことができます: //comment, /*comment*/, e05c4b47b13fdc91df7336c657836442, #comment, ''''comment'''', --comment, 'comment, %コメントなどを使用してコメントを追加します。以下の記事ではコードアノテーションの方法をカテゴリー別に紹介していますので、ご参考になれば幸いです。

コードコメントを追加するにはどうすればよいですか?

一般的なコード コメント メソッド:

HTML コメント

<!--这里是注释-->

#CSS コメント

/*这里是注释*/

#JavaScript コメント

単一行コメント:

//这里是注释

ブロック(複数行) コメント:

/*这里是注释*/

XML コメント

<!--这里是注释-->

C/C /C# コード コメント


単一行コメント:

//这里是注释

ブロック (複数行) コメント:

/*这里是注释*/

Java コメント


単一行コメント:

//这里是注释

ブロック (複数行) コメント:

/*这里是注释*/

Python コメント

単一行コメント:

#这里是注释

ブロック (複数行) コメント:

&#39;&#39;&#39;这里是注释&#39;&#39;&#39;

VB コメント

&#39;这是一个单行注释
注: これは一重引用符の後にコメント

# が続きます。


##perl コメント

単一行コメント:

# 这是一个单行注释

ブロック (複数行) コメント:

=pod 
这里是注释
=cut


Matlab コメント

単一行コメント:

%这里是注释

ブロック (複数行) コメント:

%%这里是注释%%
%{这里是注释%}

R 言語のコメント

単一行コメント:

#这里是注释

ブロック (複数行) コメント:

if(false){这里是注释}

コメントを追加する理由

コメントはコードの「ヒント」または「説明」であり、ドキュメントではありません。コメントは主にコードの複雑さを説明するために使用されます。コメントは正確で理解しやすいものである必要があります(曖昧さのないように) ) 性別)、簡潔; プログラム内の有効なコメントの量は 20% 以上である必要があります。コードにコメントを追加することは間違いなく良い習慣です。コードを書きながらコメントするのが最善です

コメントの目的: コードのメンテナンスを容易にすること、コードの機能とメソッドを説明すること、読者が読みやすくし、情報の不必要な重複を防ぎます。

注: コードが明確で一目瞭然の場合は、コメントを追加する必要はありません。詳細すぎるコメントは、人々を退屈させてしまう可能性があります。コメントを追加しないと他の人が理解できないと考えないでください。

以上がこの記事の全内容です、皆様の学習のお役に立てれば幸いです。さらにエキサイティングなコンテンツについては、PHP 中国語 Web サイトの関連チュートリアルのコラムに注目してください。 ! !

以上がコードコメントを追加するにはどうすればよいですか?の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

声明:
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。