各プログラミング言語のコメントの書き方一覧!わかりやすいコメントを書きたいものだ

よこのじ(@yokonoji_work)です。

プログラミングする際、ソースコードに設計意図や注意点をコメント記述するかと思います。

エディタでCtrl + / を入力すれば言語ごとの方法でコメントアウトしてくれますが、使い慣れていない言語の場合は、いざ手打ちしようとするとどうやってコメントを書くんだっけ?となることも…

各プログラミング言語でのコメントの書き方をまとめましたので、ご確認ください。

コメントアウトの記述方法

HTMLのコメントの書き方

<!-- コメント -->

CSSのコメントの書き方

/* コメント */

JavaScirptのコメントの書き方

// コメント
/*
複数行コメント
複数行コメント
*/

PHPのコメントの書き方

// コメント
# コメント
/*
複数行コメント
複数行コメント
*/

Rubyのコメントの書き方

# コメント
=begin
複数行コメント
複数行コメント
=end

Pythonのコメントの書き方

# コメント
"""
複数行コメント
複数行コメント
"""
```
複数行コメント
複数行コメント
```

GO言語のコメントの書き方

// コメント
/*
複数行コメント
複数行コメント
*/

JAVAのコメントの書き方

// コメント
/*
複数行コメント
複数行コメント
*/

C言語,C++,C#のコメントの書き方

// コメント
/*
複数行コメント
複数行コメント
*/

Swiftのコメントの書き方

// コメント
/*
複数行コメント
複数行コメント
*/

Scalaのコメントの書き方

// コメント
/*
複数行コメント
複数行コメント
*/

R言語のコメントの書き方

# コメント
if(0) {
複数行コメント
複数行コメント
}

複数行のコメントを書く方法はないのですが、if(0)で絶対に実行されないif文の中に書いた文字をコメントとするテクニックがあります。

コメントが楽しくなるデザイン一覧

上記のコメントの書き方と合わせて、コメントをちょっとおしゃれな感じで囲うと少しコメントを書くのが楽しくなるかも?

◆――――――◆――――――◆――――――◆――――――◆
コメント、コメント
◆――――――◆――――――◆――――――◆――――――◆

■〓■〓■〓■〓■〓■〓■〓■〓■〓■〓■〓■〓■〓■〓■
コメント、コメント
■〓■〓■〓■〓■〓■〓■〓■〓■〓■〓■〓■〓■〓■〓■

□■□■□■□■□■□■□■□■□■□■□■□■□■□■□
コメント、コメント
□■□■□■□■□■□■□■□■□■□■□■□■□■□■□

■━■━■━■━■━■━■━■━■━■━■━■━■━■━■
コメント、コメント
■━■━■━■━■━■━■━■━■━■━■━■━■━■━■

□━□━□━□━□━□━□━□━□━□━□━□━□━□━□
コメント、コメント
□━□━□━□━□━□━□━□━□━□━□━□━□━□━□

〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓
コメント、コメント
〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓

∪∩∪∩∪∩∪∩∪∩∪∩∪∩∪∩∪∩∪∩∪∩∪∩∪∩
コメント、コメント
∪∩∪∩∪∩∪∩∪∩∪∩∪∩∪∩∪∩∪∩∪∩∪∩∪∩

+:-:+:-:+:-:+:-:+:-:+:-:+:-:+:-:+:-:+:-:+:-
コメント、コメント
+:-:+:-:+:-:+:-:+:-:+:-:+:-:+:-:+:-:+:-:+:-

♪~~♪~~♪~~♪~~♪~~♪~~♪~~♪~~♪
コメント、コメント
♪~~♪~~♪~~♪~~♪~~♪~~♪~~♪~~♪

。°+°。°+ °。°。°+°。°+ °。°。°+°。°+ °。°
コメント、コメント
。°+°。°+ °。°。°+°。°+ °。°。°+°。°+ °。°

∴‥∵‥∴‥∵‥∴‥∴‥∵‥∴‥∵‥∴‥∴‥∵‥∴
コメント、コメント
∴‥∵‥∴‥∵‥∴‥∴‥∵‥∴‥∵‥∴‥∴‥∵‥∴

☆.。:・★.。:*・☆.。:*☆.。:*・★.。:*・☆.。☆.。:*・★
コメント、コメント
☆.。:・★.。:*・☆.。:*☆.。:*・★.。:*・☆.。☆.。:*・★

。:*-♪-*:。-♪-。:*-♪-*:。-♪-。:*-♪-*:。-♪-。:*-♪-*
コメント、コメント
。:*-♪-*:。-♪-。:*-♪-*:。-♪-。:*-♪-*:。-♪-。:*-♪-*

■-□-■-□-■-□-■-□-■-□-■-□-■-□-■-□-■-□-■-□-■
コメント、コメント
■-□-■-□-■-□-■-□-■-□-■-□-■-□-■-□-■-□-■-□-■

▼△▼△▼△▼△▼△▼△▼△▼△▼△▼△▼△▼△▼△
コメント、コメント
▼△▼△▼△▼△▼△▼△▼△▼△▼△▼△▼△▼△▼△

◆◇◆◇◆◇◆◇◆◇◆◇◆◇◆◇◆◇◆◇◆◇◆◇◆◇
コメント、コメント
◆◇◆◇◆◇◆◇◆◇◆◇◆◇◆◇◆◇◆◇◆◇◆◇◆◇

☆★☆★☆★☆★☆★☆★☆★☆★☆★☆★☆★☆★☆
コメント、コメント
☆★☆★☆★☆★☆★☆★☆★☆★☆★☆★☆★☆★☆

 

リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック