問題タブ [readability]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
whitespace - ウェブページのソースに空白を追加して読めるようにする
- 表示している Web ページに興味があります。
- 「view--page source」を使用して、html を含むウィンドウを取得します。
これを切り取ってメモ帳++に貼り付けます。
空白を追加して手動で解析し、読みやすくします。
最後のステップを実行するためのより良い方法はありますか? このプロセスを自動化し、ユーザーにソース ファイルの読み取り可能なバージョンを提供する何かが書かれていることを願っています。
助けてくれてありがとう。
-明細書
coding-style - 長いパラメータリストを読みやすくする方法は?
関数内の長いパラメーターリストに対する自然な嫌悪感を開発しました。これはある程度良いことですが、「手動インライン化」のために、コードの重複や途方もなく長い関数と比較して、長いパラメータリストが2つの悪のうちの少ない方である場合があります。少なくともこれらの怪物のいくつかを人間が読めるようにするための良い方法は何ですか?例えば:
これは読みやすさの尺度では高得点ではありませんが、多くの場合、4つのパラメーターはかなり妥当です。
coding-style - 重い関数呼び出しのネスティングの可読性?
頻繁にネストされた関数呼び出しは読み取り不能であるため、使用すべきではないと主張しているのをよく見ました。ただし、代わりに一時変数を使用すると、多くの不必要な冗長性が作成され、読者は各一時変数をそれが表すものに精神的にリンクする必要があります。Lisp コードが一般的にフォーマットされている方法を見て、入れ子を反映するようにフォーマットすると、ネストされた関数呼び出しを実際に非常に読みやすくすることができることに気づきました。例えば:
ネストされた関数形式で最初の例のようなものを書くことは、私見ですが、より手続き型のコードで次のことを行うことと同等です。
どちらの場合も、本当の問題は不適切なフォーマットであり、過度のネストではありません。適切にフォーマットされたネストされた関数バージョンと一時変数バージョンの読みやすさ/わかりやすさをどのように評価しますか? 最大の読みやすさのためにフォーマットされていても、重い関数呼び出しの入れ子は悪いスタイルだと思いますか? もしそうなら、なぜですか?
c# - foreach(... in ...) または .ForEach(); それが問題です
重複の可能性:
C# の foreach と機能的な each
これは読みやすさのためのコーディングに関する質問です。
マスクする必要がある機密情報を含む要素の名前XDocument
とList<string>
名前があります (この例ではアンダースコアに置き換えます)。
これは、従来のforeach
ループを使用.ForEach
する方法と、lamba 構文のメソッドを使用する方法の 2 つの方法で記述できます。
また
どのアプローチが最も読みやすいと思いますか?その理由は? 2 番目の例を好む場合、読みやすくするためにどのように表示しますか?
python - コーディング スタイル - 同じ行または新しい行に括弧を付けますか?
読みやすくするために、明らかにステートメントを数行に分割する必要がある関数を呼び出しているとします。ただし、少なくとも 2 つの方法があります。
あなたはこれをしますか:
または、次のようにします。
または、独自のフォーマットを提案してください。また、特定の書式を使用する理由と、他の書式の何が問題なのかを記載してください。
ありがとう
c# - Fry Graphの読みやすさの式のレベルを取得するにはどうすればよいですか?
私は、Gunning-Fog、Precise SMOG、Flesh-Kincaidなど、いくつかの読みやすさの式をテキストに適用するアプリケーション(C#)で作業しています。
ここで、プログラムにFryベースのGrade式を実装する必要があります。式のロジックを理解しています。ほとんどの場合、100語のサンプルを3つ取り、100語あたりの文と100語あたりの音節の平均を計算します。 、グラフを使用して値をプロットします。
この式がどのように機能するかについてのより詳細な説明があります。
私はすでに平均を持っていますが、「グラフをチェックして値をプロットし、レベルを教えてください」とプログラムに指示する方法がわかりません。グラフをユーザーに表示する必要はありません。レベルを表示するだけです。
たとえば、次のように、レベルに分割されたすべての値をメモリに含めることができると考えていました。
レベル1:文の平均が10.0〜25 +で、音節の平均が108〜132の値。
レベル2:文の平均が7.7から10.0の間の値、および....など
しかし、問題は、これまでのところ、レベルを定義する値を見つけた唯一の場所がグラフ自体にあり、それらはあまり正確ではないため、上記のアプローチを適用すると、グラフからの値では、私のレベルの推定値は不正確すぎるため、フライベースのグレードは正確ではありません。
ですから、フライベースのグレードのさまざまなレベルの正確な値を見つけることができる場所について知っている人もいれば、これを回避する方法で考えるのを手伝ってくれる人もいるかもしれません。
ありがとう
javascript - 読みやすさとIFブロックブラケット:ベストプラクティス
JavaScriptの基本を学ぶレベル1の大学生向けの短いチュートリアルを準備しています。タスクは、電話番号を検証することです。数字には数字以外の数字を含めることはできず、14桁以下にする必要があります。次のコードの抜粋は私が思いついたものであり、可能な限り読みやすくしたいと思います。
簡単な質問私は自分自身に完全に答えることができず、あなたの意見を聞きたいです:周囲の(最も外側の)ブラケットをどのように配置するか?通常のブラケットと中括弧の違いを理解するのは難しいです。あなたは通常)
、最後の条件と同じ行に最後を置きますか?あなたは(
それ自体でラインの最初のオープニングを維持しますか?個々のサブ条件も角かっこで囲んでいますか?(
最初と最後を水平に揃えます)
か、それとも最後)
を?と同じ列に配置しif
ますか?
) {
別の行を保持しますか、それとも)
最後のサブ条件と同じ行に最後を配置して{
から、新しい行に開口部を配置しますか?それとも) {
、最後のサブ条件と同じ行にを配置しますか?
コミュニティウィキ。
編集 ブラケットの使用法と配置に関する意見のみを投稿してください。コードをリファクタリングする必要はありません。これは、数週間前にJavaScriptを紹介したばかりの人向けです。コードを短くしたり、パフォーマンスを向上させたりするために、コードの書き方について意見を求めているわけではありません。IF条件の前後に角かっこをどのように配置するかを知りたいだけです。
css - VisualStudioのカスタムフォーマットドキュメントオプション。CSSタグのフォーマット
VS2008で作業するときは、時間を大幅に節約できるため、Ctrl + K+Dを頻繁に使用します。
しかし、CSSファイルでは、このコマンドは私があまり好きではない方法でドキュメントをフォーマットします。
たとえば、ドキュメントを自動フォーマットすると、
ただし、(私の意見では)はるかに読みやすいので、この方法でタグをフォーマットするのが好きです。
だから、私がこれを実装できる方法はありますか?
「タグ固有のオプション」機能は私が必要としているもののようですが、これを行う方法がよくわかりません。
ありがとう。
coding-style - 調査レポートでコードをフォーマットする方法
現在、正式な調査レポートを作成しており、このレポートにコードを含める予定です。
質問:調査レポートにコードを表示する方法として認められているものはありますか? フォント、スペースなどの点と、コードをドキュメント内に表示するか、付録に表示するかの両方について考えています。
コードは JavaScript と PHP になります。コードのどのセクションも 25 行を超えることはありません (したがって、これらは単なるスニペットです)。約半ダースのスニペットがあります。各スニペットには、コードで何が起こっているかを説明するいくつかの段落と、その長所/短所に関する議論があります。
私は報告書の提出先の組織と連絡を取り合っておらず、コードのフォーマット方法に関するガイドラインも公開していません (これらの点について質問しないでください)。
coding-style - インデントが不十分なコードがたくさんあるのはなぜですか?
Python以外の言語でオープンソースプロジェクトのコードを参照すればするほど、多くのプログラマーが適切なインデントを信じていないように見えることに気付きます。(この質問を個人的に受けすぎないようにするためのプロジェクトについては特に言及しません。)通常、コードはインデントされていますが、特に古い/粗雑なコードでは、標準のスタイルとはまったく異なる方法で私を夢中にさせます。私がCのような言語で書くとき、私はPythonで書いているときと同じように正しくインデントする傾向があることに気づきました。ただし、実際に親指のように突き出したいデバッグコードは例外です。最新のIDEを使用すると、誤ったインデントを修正するのがいかに簡単であるかを考えると、インデントを中括弧と同期させない理由は何ですか?