かっこいい複数行コメントの書き方

Question

プログラミング言語によって複数行にわたるコメントの書き方や流儀が様々だと思います。

一行一行先頭にコメントアウトをしてくれる文字を書くのはダサいように思われます。
複数行用のコメントアウトの方法が準備されていても、視覚的にコメントアウトだと訴えることができないかもしれません。

そういうとき、"-"などで線のようなものを引いて見た目を工夫されたりするのだと思うのですが、皆様はどのような工夫をされていますか。そんな工夫などしないという意見も含めて教えてください。どの言語かも書いていただけると幸いです。

Answer 1

Javaプログラマーです。

`
/**********************************

• コ
• メ
• ン
• ト

**********************************/
`

シンプルですがわかりやすくていいかなぁ、と思っています。

Comments

[tsuntsun]

同じスタイルです（ｗ）

[HandStand_Cat]

簡単で見やすいですよねっ。

Answer 2

かっこいいかは分かりませんが、フレームワークでよくあるコメントの書き方でこのようなのがあります。

`/**

• @param array $arr
• @return void

*/
`

メソッドなどの説明でこれを使うときがあります。

Comments

[mitei]

補足すると、これは Doxygen というツール用の記法で、ソースコード中に Doxygen の記法に従った形式でコメントを書いておくと、Doxygen ツールによって HTML 形式などのドキュメントを簡単に生成することが出来ます。
有名なオープンソースのプロジェクトでも良く使われています。
有名なエディタや IDE なら Doxygen 形式のコメントを書くのを補助するようなプラグインも作られていたりします。

Answer 3

PHPのプログラマーです。

かっこいいかどうかはわかりませんが、こんなのはいかがでしょうか？
ちなみに、私は候補③をよく使います。

【候補①】
//☆★☆★☆★☆★☆★☆★☆★☆★☆★☆★☆★ // // //☆★☆★☆★☆★☆★☆★☆★☆★☆★☆★☆★

【候補②】
//============================================ // // //============================================

【候補③】
//******************************************** // // //********************************************

Answer 4

Mozilla Developer Networkで見かけたコメントがかっこよかったので紹介しておきます。

` /
|| このあたりが
|*| コメントの内容
*/

`
ただし、半角バックスラッシュが出ない環境では少し残念です。

Answer 5

Mozilla Developer Networkで見かけたコメントがかっこよかったので紹介しておきます。

` /
|| このあたりが
|*| コメントの内容
*/

`
ただし、半角バックスラッシュが出ない環境では少し残念です。

Answer 6

各行頭に*をつけると行が増えた時に書き足さなければならないので,
/* コメント */
です.

Answer 7

Rubyだったらこれはどうでしょうか？

%#******************************* p 'no hello1' p 'no hello2' p 'no hello3' p 'no hello4' p 'no hello5 *********************************# p 'hello'

この場合だと"hello"とだけ出力されます。
hello1～hello5は出力されません。

しかし普段は、=begin =endを使います。

Answer 8

/* HOEHOGE
-------------------------------------------------------------------------------*/

Answer 9

メインは C++ で、その他の言語もちょこちょこ使ってます。

複数行コメントとしての工夫はしていませんが、
ソース内の構成を示す区切りとして見出し的なコメントで線を使ってます。

`
////////////////////////////////////////////////////////////////
// 大見出し
////////////////////////////////////////////////////////////////

// 小見出し
////////////////////////////////////////////////////////////////
`

線は C++ "/", Ruby "#", Lisp ";" のようにその言語のコメント文字の連続させます。
Emacs だと C-u C-u C-u # といったキーで入力できるので。