web-dev-qa-db-ja.com

関連するコードをすばやく見つけることができる名前はありますか?

私がハッキングするのが好きなコードベースの特性は、コードベースについてまったく知らなくても、いくつかの機能に関連するコードをすばやく見つけることができるということです。たとえば、GUIでラベルを検索し、その機能を実装するコードをすぐにヒットします。

これは、ラベルがおそらくI18Nモジュールの背後に埋め込まれ、ビジネスロジックがMVCフレームワークでさらに削除される抽象化レイヤーと直接的な緊張関係にあるようです。 (たとえば、コメントにGUIラベルを含めることで軽減できます。)

これは明らかに保守性の一部ですが、この特定の望ましいプロパティの名前はありますか?

3
Steve Bennett

発見可能性または学習可能性はこの概念に適用できます。ただし、何かを発見可能にすることは、初めてのユーザー向けに最適化する可能性があることに注意してください。 ここ関連の議論を見てください。

4
Jordão

この概念専用のWordがあるとは思いませんが、これらのコードベースの使いやすさは、多くの場合、いくつかの原因に起因する可能性があり、そのすべてに次の用語があります。

  • 十分に文書化されています-コメント、外部ドキュメント、内部解析可能ドキュメント(JavaDocsなど)、および指示変数名が含まれます。
  • よく整理された-設計と計画を示します
  • 読み取り可能-他の2つの結果に加えて、これはPythonなどの特定のプログラミング言語の意図的な設計選択であり、設計イデオロギーの中心的な「柱」になります。
3
Southpaw Hare