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

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

ただいまの
回答率

88.11%

javascriptのコメントの書き方とスペースの書き方

解決済

回答 4

投稿

  • 評価
  • クリップ 0
  • VIEW 482

score 120

些細なことなのですが、javascriptでコメントを書く時に、スペースを空けるかどうか迷っています。
正しい(?)書き方はどうなっているでしょうか。

//スペースを開けずにコメント
// スペースを1つ空けてコメント
let func_1 = function(){
  console.log("pass");
};

また、別の質問になりますが、空行にはスペースを書いた方が良いのでしょうか。
それとも、書かなくても良い?
例えば、下記の様な書き方です。

<div>
  <p>sample</p>
  /* ↓↓↓↓ 空行だが2マススペース空けている ↓↓↓↓ */

  <p>sample_2</p>
</div>

因みに、タブは使っておりません。

以上、宜しくお願い致します。

  • 気になる質問をクリップする

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

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

    クリップを取り消します

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

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

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

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

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

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

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

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

    質問の評価を下げる

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

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

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

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

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

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

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

    詳細な説明はこちら

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

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

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

回答 4

+2

読みやすければどちらでも良いです。
実務の場合は現場でルールがある場合があるので現場で確認してください。

「コメント」のほうに蛇足ですが、JavaDocをもとにしたJSDocというのがあります。
参考まで。

投稿

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

  • 2019/07/24 10:49

    回答ありがとうございます。
    個人開発なので、書きやすい方で書きたいと思います。
    JSDocは便利そうですね。

    キャンセル

checkベストアンサー

+1

空行にはスペースを書いた方が良いのでしょうか。
それとも、書かなくても良い?

一般に、「行末の空白はすべて消す」という設定にすることが多いので、そうしていると空行のインデントも「行末の空白」に該当して、消えてなくなります。

投稿

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

  • 2019/07/24 10:44

    >一般に、「行末の空白はすべて消す」という設定にすることが多い
    現場によっては「DIFFとったときに実際は手を加えてない行も変更されたと出るから」と
    その設定をオフにするように言われるところもあったりしますね。
    大抵は追加・変更・削除を全てコードに残すようなかなりレガシーな現場ですが。

    キャンセル

  • 2019/07/24 10:48

    回答ありがとうございました。
    空白は空けないように致します。

    キャンセル

  • 2019/07/24 11:00

    > 空白は空けないように致します。

    設定すれば保存時にエディタが消してくれるので、意識する必要もなくなります。

    キャンセル

  • 2019/07/24 11:36

    設定、ありました。
    秀丸にもあるんですね。

    キャンセル

+1

「正しい」「正しくない」はそのプロジェクトなりの規約・ガイドラインによります。
そういったモノがない状況なら、エラーにも警告にもならない書き方はどれも「正しい」とするしかないです。

投稿

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

  • 2019/07/24 10:53

    回答ありがとうございます。
    特にこれと言った決まりはないということですね。

    キャンセル

  • 2019/07/24 11:02

    強いて言えば「構文的に正しい」ぐらいしか「正しさ」を判断する基準がない、というだけで、それ以上は主観の問題でしかありません。

    キャンセル

0

好みの問題なので見やすければ何でもいいと思いますが、必ずチーム・プロジェクト(個人開発なら自分の中)で必ず統一する必要はあります。
同じソースコードに違う書き方があるのは個人的に気持ち悪いです。

投稿

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

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

  • ただいまの回答率 88.11%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

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