
包括的なオンラインカタログ
ウェブサイトにアクセス・プリプリント・スプリンガーペーパー・論文このリポジトリには、現在の臭いのリストが含まれているコード臭いカタログWebサイトのソースが含まれています。
ウェブサイトにアクセスして閲覧してください!
データをこするには、リポジトリをクローンしてpython /data_scraper/main.pyを実行したい場合。
みんな
新しい開発者は、コードの臭いリストをすてきで読みやすい形式の記事で閲覧し、それらについて読んで、悪い習慣である可能性のあるものや注意すべきことの良い直観を得ることができます。
彼らは、匂いの説明、潜在的な因果関係の例、および特定のコードの匂いについてのテーブル形式の高度な抽出属性を見つけることができます(クラス内またはクラス間で発生する臭いなど)。それに加えて、コードの匂いの大部分には、新しいことについて学んでいるときに非常に重要な例があります。
誰かが彼の懸念のソースに直接リンクを置くことができるとき、コードレビューのディスカッションを処理する方がはるかに簡単です。これは、開発者間のコード臭いの理解に利益をもたらし、加速する可能性があります。
開発者の大部分は、この問題自体を指定された現象として知らずに、これらのことのほとんどを直感的に知っているかもしれません。これにより、開発者の全体的なスキルを向上させることができます。
臭いに関するデータと情報は散らばっており、すべての臭いを集めて、それらの研究を全体的に実行することは困難です。現在、2022年の時点で、さまざまな臭いに関する研究されたデータは大幅に不均衡です。いくつかのコードの匂いは、ほとんど常に考慮され、一部はめったにありません、そしていくつかは研究のカバーされていません。
このカタログは、利用可能なデータを統一し、命名法(同義語)とこの問題を検討できるさまざまな視点(分類法)を標準化するように設計されています。
貢献したい場合は、問題で新しい議論を開いたり、新しいマージリクエストを開いて変更を直接追加したりすることで大歓迎です。私はいくつかの議論があるかもしれないと思う(私はこのような巨大なものの中で、統計的に言えば、間違いを犯さなければならなかったと深く確信している) 。 ?
これは、誰もが理論的な側面から貢献するのができる限り簡単になると想定されています - Webサイトの内容はcontentディレクトリのMarkdownのようなファイルで管理できるため、プログラミング言語を知る必要はありません。コンテンツは標準のmarkdown形式で、 YAML形式のMarkDownファイルヘッダーの重要なデータがあります。