質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

90.40%

  • プログラミング言語

    710questions

    プログラミング言語はパソコン上で実行することができるソースコードを記述する為に扱う言語の総称です。

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

解決済

回答 9

投稿

  • 評価
  • クリップ 10
  • VIEW 14K+

skz

score 128

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

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

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

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 9

+9

Javaプログラマーです。

/**********************************
* コ
* メ
* ン
* ト
**********************************/

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

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2014/07/18 13:48

    同じスタイルです(w)

    キャンセル

  • 2014/07/23 13:31

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

    キャンセル

checkベストアンサー

+6

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

`/**
 * @param array $arr
 * @return void
 */ 
` メソッドなどの説明でこれを使うときがあります。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2014/07/18 18:04

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

    キャンセル

+4

PHPのプログラマーです。

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

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

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

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

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

+2

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

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

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

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

+2

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

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

+2

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

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

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

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

+2

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

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

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

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

+1

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

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

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


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

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

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

+1

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

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

同じタグがついた質問を見る

  • プログラミング言語

    710questions

    プログラミング言語はパソコン上で実行することができるソースコードを記述する為に扱う言語の総称です。