1. ホーム
  2. javascript

[解決済み] node.jsアプリのコーディングスタイルガイド?[クローズド]

2022-06-27 01:23:42

質問

node.jsのコーディングスタイルガイドはありますか?ない場合、どのような 新しいスタイル は何ですか?

私は以下のようなガイド(またはいくつかのガイド)を探しています。 PEP 8 という、Python の標準的なコーディングスタイルガイドに沿ったガイド (またはいくつかのガイド) を探しています。私は、ここにリンクする価値のない様々なJavaScriptのガイドを見ました(ほとんどは古く、クライアントサイドのJavaScriptを対象としています)。node.jsの面白いものを見つけました。 スタイルガイド .

コーディングスタイルガイド、またはコーディング規約は、以下を含むべきです(ただし、これらに限定されるものではありません)。

  • コードのレイアウト: インデント (スペース 2 つ、スペース 4 つ、タブ、...)、改行、改行、など。
  • 空白文字、例えば "function (arg)" vs. "function(arg)"
  • セミコロンがあるかないか、var 宣言、...。
  • ネーミング、例えば do_this() vs. doThis()、var_name vs. varName、...。
  • node.js と JavaScript のイディオム、例えば == vs. ===、コールバックの最初の引数はエラーオブジェクト、....
  • コメントとドキュメント
  • lint チェッカー、ユニットテストフレームワーク、...などの付属ツール

このトピックは明らかに非常に主観的ですが、成熟する過程で、共通で広く受け入れられるコーディングスタイルを確立することは、コミュニティの重要なステップだと考えています。また、それはすべて好みだけの問題ではありません。特に、"use === instead of ==" のようなルールは、コードの品質に直接影響を及ぼします。

どのように解決するのですか?

でチェックしたコーディングスタンダードを見直すと JSLint の作者を見てみたり NPM (Isaac Shlueter の) コーディング規約 .

また、著名なNode.JSコーダーによって使用されるスタイルを見ることもできます。

私は 投げる を入れることにします;)

編集: 提案は アリエンハルド

IMOは、あなたが従うべきいくつかの黄金律があります。

  • 決して with または eval
  • 使用する === 以上 ==
  • 変数の宣言は常に var で宣言してください - グローバルスコープにフォールバックしないでください。
  • アプリをクロージャで囲む (function(){})() ブラウザだけでなくサーバーサイドで動作するコードをリリースする予定であれば
  • コールバックは err を最初の引数として取り、それ自身がコールバックを引数として取る場合は、最後にする必要があります。 callback(err, param1, param2, callback)

インデント、中括弧とキーワードの間隔、セミコロンの配置は、すべて好みの問題です。