Loading article…
コンピュータプログラミングにおいて、コード臭とは、プログラムのソースコードに見られる、より深刻な問題を示している可能性のある特徴のことです。 [1] [2]コード臭であるかどうかの判断は主観的であり、言語、開発者、開発方法論によって異なります。
この用語は、1990年代後半にKent BeckによってWardsWikiで普及しました。 [3]この用語の使用は、1999年にMartin Fowlerが著した書籍「Refactoring: Improving the Design of Existing Code」で取り上げられてから増加しました。[4]また、アジャイルプログラマーが使用する用語でもあります。[5]
意味
臭いを捉える一つの方法は、原則と品質に関するものである。「臭いとは、コード内の特定の構造が、基本的な設計原則に違反していることを示し、設計品質に悪影響を与えることである」[6] 。コード臭いは通常、バグではない。技術的に間違っているわけではなく、プログラムの動作を妨げるものでもありません。むしろ、コード臭いは、開発を遅らせたり、将来的にバグや障害のリスクを高めたりする可能性のある設計上の弱点を示しています。悪いコード臭いは、技術的負債に寄与する要因の指標となることがあります。[1] Robert C. Martin は、コード臭いのリストをソフトウェア職人の「価値体系」と呼んでいます。[7]
これらの厳しい解釈とは対照的に、カニンガムの元々の定義は、匂いは何かが間違っているかもしれないという示唆であり、すでに問題があるという証拠ではないというものでした。[3]
多くの場合、コード臭によって示唆されるより深刻な問題は、コードを短いフィードバック サイクルにかけたときに明らかになります。短いフィードバック サイクルでは、コードを小さな制御されたステップでリファクタリングし、結果として得られる設計を調べて、さらなるリファクタリングの必要性を示唆するさらなるコード臭がないかどうかを確認します。リファクタリングの実行を担当するプログラマーの観点から見ると、コード臭は、いつリファクタリングするか、およびどの特定のリファクタリング手法を使用するかを示すヒューリスティックです。したがって、コード臭はリファクタリングの原動力です。
コードのわかりやすさ、変更のしやすさ、機能変更をサポートするために拡張できる容易さ、さまざまな設定で再利用できるコード、テストのしやすさ、コードの信頼性などの要素は、コード臭を識別するために使用できる要素です。[8]
2015 年の調査[1]では、 50 万件のソースコードコミットの自動分析と、「コードの臭い」があると判断された 9,164 件のコミットの手動検査を実施し、次の結果が判明しました。
- 「技術的負債」の結果については経験的証拠は存在しますが、これがどのように、いつ、なぜ発生するかについては逸話的な証拠しかありません。
- 一般的な見解では、緊急のメンテナンス活動や、コード品質よりも市場投入までの時間を優先しながら機能を提供するプレッシャーが、このような臭いの原因となることが多いようです。
Checkstyle、PMD、FindBugs、SonarQubeなどのツールは、コードの臭いを自動的に識別できます。
参照
参考文献
- ^ abc Tufano, Michele; Palomba, Fabio; Bavota, Gabriele; Oliveto, Rocco; Di Penta, Massimiliano; De Lucia, Andrea; Poshyvanyk, Denys (2015). 「コードが悪臭を放つようになるのはいつ、なぜか」(PDF) . 2015 IEEE/ACM 37th IEEE International Conference on Software Engineering . pp. 403–414. CiteSeerX 10.1.1.709.6783 . doi :10.1109/ICSE.2015.59. ISBN 978-1-4799-1934-5. S2CID 59100195。
- ^ Fowler, Martin. 「CodeSmell」. martinfowler.com/ . 2014年11月19日閲覧。
- ^ ab Beck, Kent. 「Code Smells」. WikiWikiWeb . Ward Cunningham . 2020年4月8日閲覧。
- ^ ファウラー、マーティン(1999)。リファクタリング。既存コードの設計の改善。アディソン・ウェズリー。ISBN 978-0-201-48567-7。
- ^ Binstock, Andrew (2011-06-27). 「In Praise Of Small Code」. Information Week . 2011-06-27閲覧。
- ^ Suryanarayana, Girish (2014 年 11 月)。ソフトウェア設計の臭いに対するリファクタリング。Morgan Kaufmann。p. 258。ISBN 978-0128013977。
- ^ Martin, Robert C. (2009). 「17: 匂いとヒューリスティック」.クリーンコード: アジャイルソフトウェア職人技のハンドブック. Prentice Hall. ISBN 978-0-13-235088-4。
- ^ スリヤナラヤナ、ギリシュ、ガネーシュ サマルティヤム、トゥシャール シャルマ。ソフトウェア設計のリファクタリングの匂い: 技術的負債の管理 / Girish Suryanarayana、Ganesh Samarthyam、Tushar Sharma。第1版。ウォルサム, マサチューセッツ州 ;モーガン・カウフマン、2015 年。印刷。
さらに読む
- Garousi, Vahid; Küçük, Barış (2018). 「ソフトウェアテストコードの臭い: 業界と学界における知識の調査」Journal of Systems and Software . 138 : 52–81. doi :10.1016/j.jss.2017.12.013.
- Sharma, Tushar; Spinellis, Diomidis (2018). 「ソフトウェアの臭いに関する調査」。システムとソフトウェアのジャーナル。138 : 158–173。doi : 10.1016 /j.jss.2017.12.034。
外部リンク
- 「CodeSmell」. martinfowler.com . 2022年3月1日閲覧。
- バウンディ、デビッド、ソフトウェア ガン: 7 つの早期警告サイン、またはここ、ACM SIGSOFT ソフトウェア エンジニアリング ノート、第 18 巻第 2 号 (1993 年 4 月)、Association for Computing Machinery、ニューヨーク、ニューヨーク州、米国