web-dev-qa-db-ja.com

80文字の制限を超えるコメントの長いURLを処理するにはどうすればよいですか?

私は通常、コード行ごとに80文字の制限を遵守して、同僚を満足させ、リンティングツールを満足させ、ランダムな人が私のコードを見るときにプロ意識のイメージを維持しようとします。

ただし、コメントに埋め込みたいURLがあり、これらのURLの一部が非常に長い(80文字を超える)場合があります。誇張された例:https://github.com/Django/django/blob/42b9a23267f14be39b9b00958e18d5746783208e/Django/contrib/auth/management/commands/changepassword.py#L17-L21

プロのソフトウェアエンジニアはこの問題にどのように対処しますか?長いURLの80文字の規則に例外を設けていますか?

2
Flux

彼らが言った任意のルールに従ってください。

彼らが言っても大丈夫だろう。

彼らが言ったすべての完璧の源を発見しました。

彼らが言った規則に違反するものは決してあり得ない。

彼らは明らかにコードを書かなかった...


書式設定ガイドがあるとすばらしいので、予測可能な答えで同じ質問に答えるのに役立ちます。

しかし-そして常に-ありますが-あなたはコードを書いています。なぜなら、以前はこの目的のためにこのように書く必要はなかったからです。

したがって、それは新しく、斬新であり(たとえそれがオリジナルではないコピー、貼り付け、および名前変更であっても)、彼らはこれまでにそれを見たことがない。

どのようにして、宇宙全体を考慮せずに普遍的に適用できる「ルール」を作成できたでしょうか。 ヒント-彼らは持つことができません...


せいぜいこの80文字の制限は、一般に役立つ経験則です。そして、私はそれが印刷媒体と適切にフォーマットされたドキュメントにいくらかの基礎を持っているのを見ることができます。

しかし、あなたは何かを忘れました-tility経験則80文字制限の本来の意図であると私は思います。

  • 不要な空白を挿入して手動で行を折り返すと、URLは機能しません。

ニュースコラムニスト、本の著者、またはWebデザイナーにとって、どちらがより専門的ですか? おそらく、約80文字でリンクを行折り返し、その媒体の規則と標準を使用して、読者を手がかりにしたり、リンクを実用的な方法で提示するために利用可能なテクノロジーを使用したりします。

プログラマーにとってどちらがよりプロフェッショナルですか?

2人のプログラマの間で採用を選択した場合:

  • uRLをかなりフォーマットした人、
  • そしてそうしなかった人。

しかし、他のすべての点で同等です。あなたはどちらを雇いますか?

次の開発者の人生を難しくしないようにして、彼らが目標を理解するのに十分な専門家だったので、私はそうしなかった人を雇うでしょう。

6
Kain0_0

80文字の制限の起源は、画面が80文字しか処理できない時代からのものであり、それはあなたが十分に新しいものを持っている場合にのみでした。初期のプリンターは、判読可能な1インチの境界線のある印刷で80文字しか処理できなかったため、少し長く続きました。

現在、私たちの画面は1行あたり100文字をはるかに超える文字を処理できます。制限する唯一の理由は、印刷されるページに適度に収まるものです。そのため、ほとんどのコーディングガイドラインは、1行あたり100文字または120文字に更新されています。その主な理由は、実際にコードを印刷する人々のためです。理解する必要があるレガシーコードの複雑な部分に慣れ親しんでいるときも、時々そうします。

ただし、1080pモニターがベースラインノルムである時代には、コードの印刷はほとんど発生しません。コード行の文字制限の唯一の制限は、読み取り可能なものです。

あなた自身に尋ねなければならない他の質問があります:

  • なぜソースコードのURLが最初からあるのですか?
    • それらは頻繁に変更されるため、構成アイテムの作成を検討する必要があります
  • あなたの周りの世界が変わった場合に再コンパイルを強制するソースコードの一部を作っている他のアイテムはありますか?
  • これらのURLに対処するより良い方法はありますか?
    • 彼らがあなたのプロジェクトの外の何かを参照するコメントにある場合、プロジェクトのウィキはどうですか?次に、それをクリックすると、URLが機能します。
    • コメントを読んでいるときに、URLは実際にコードを理解するのに役立ちますか?おそらく違います。
0
Berin Loritsch

制限が80文字、100文字、120文字のいずれであっても、それを超える場合があります。

しかし、ほとんどの言語では、文字列リテラルを複数の行に分割することが可能です。 Cではかなり自明です。「これ」「は」「a」「単一」「文字列」「リテラル」です。エディターが独自のフォーマットを行う場合は、エディターがコードを再フォーマットしようとした後でも、適切にフォーマットされるようにコードを記述する方法を理解してください。

0
gnasher729