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

Question

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

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

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

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

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

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

Answer 1

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

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

Comments

[uer03108]

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

Answer 2

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

Comments

[uer03108]

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

[gentaro]

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

Answer 3

空行にはスペースを書いた方が良いのでしょうか。

それとも、書かなくても良い？

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

Comments

[m.ts10806]

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

[uer03108]

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

[maisumakun]

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

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

[uer03108]

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

Answer 4

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