Empirical Study on Merits and Demerits of Comments Toward Software Quality

• Project/Area Number: 25330083
• Research Category: Grant-in-Aid for Scientific Research (C)
• Allocation Type: Multi-year Fund
• Section: 一般
• Research Field: Software
• Research Institution: Ehime University
• Principal Investigator: Aman Hirohisa 愛媛大学, 総合情報メディアセンター, 准教授 (50333513)
• Co-Investigator(Kenkyū-buntansha): AMASAKI Sousuke 岡山県立大学, 情報工学部, 助教 (00434978) ; HIRATA Kouji 関西大学, 工学部, 准教授 (10510472)
• Project Period (FY): 2013-04-01 – 2016-03-31
• Project Status: Completed (Fiscal Year 2015)
• Budget Amount: ¥4,810,000 (Direct Cost: ¥3,700,000、Indirect Cost: ¥1,110,000); Fiscal Year 2015: ¥1,430,000 (Direct Cost: ¥1,100,000、Indirect Cost: ¥330,000); Fiscal Year 2014: ¥1,300,000 (Direct Cost: ¥1,000,000、Indirect Cost: ¥300,000); Fiscal Year 2013: ¥2,080,000 (Direct Cost: ¥1,600,000、Indirect Cost: ¥480,000)
• Keywords: コメント文 / ソフトウェア品質 / リファクタリング

Outline of Final Research Achievements

This study performed data collections and analyses focusing on the comments written in source files. Comments usually help in comprehending the programs. However, comments can also be added to mask poor readabilities of complicated programs.
The results of this study quantitatively showed that comments written inside method (function) bodies are likely to be related to the fault-proneness in those methods (functions). This finding would be useful in enhancing the code reviewing by narrowing suspicious parts to be checked.

Research Products

• [Journal Article] Lines of Comments as a Noteworthy Metric for Analyzing Fault-Proneness in Methods (2015)
  • Author(s): Hirohisa AMAN, Sousuke AMASAKI, Takashi SASAKI and Minoru KAWAHARA
  • Journal Title: IEICE Transactions on Information and Systems Volume: E98.D Issue: 12 Pages: 2218-2228
  • DOI: 10.1587/transinf.2015EDP7107
  • NAID: 130005112331
  • ISSN: 0916-8532, 1745-1361
  • Peer Reviewed / Open Access / Acknowledgement Compliant
• [Journal Article] Feature Envy とコメント文の関連性に関する考察 (2014)
  • Author(s): 藤井 里沙，天嵜 聡介，阿萬 裕久，横川 智教
  • Journal Title: ソフトウェア工学の基礎 XXI Volume: - Pages: 69-74
• [Presentation] 共変更の新しさと開発者の貢献度合いに着目したロジカルカップリングの評価 ---ソースコード修正漏れの自動検出に向けて--- (2015)
  • Author(s): 尾田 祐之介，阿萬 裕久，川原 稔
  • Organizer: 情報処理学会ソフトウェア工学会
  • Place of Presentation: JR博多シティ会議室（福岡県福岡市）
  • Year and Date: 2015-12-15
• [Presentation] Empirical Analysis of Change-Proneness in Methods Having Local Variables with Long Names and Comments (2015)
  • Author(s): Hirohisa Aman, Sousuke Amasaki, Takashi Sasaki and Minoru Kawahara
  • Organizer: The 9th ACM/IEEE International Symposium on Empirical Software Engineering and Measurement
  • Place of Presentation: 北京市（中国）
  • Year and Date: 2015-10-19
  • Int'l Joint Research
• [Presentation] 変数名とスコープの長さ及びコメントに着目したフォールト潜在性に関する定量的調査 (2015)
  • Author(s): 阿萬 裕久，天嵜 聡介，佐々木 隆志，川原 稔
  • Organizer: 情報処理学会ソフトウェアエンジニアリングシンポジウム 2015
  • Place of Presentation: 慶應義塾大学（神奈川県横浜市）
  • Year and Date: 2015-09-07
• [Presentation] Predicting Fault-Prone Methods Focusing on the Combination of Inner Comments and Documentation Comments (2015)
  • Author(s): Hirohisa Aman, Sousuke Amasaki, Takashi Sasaki and Minoru Kawahara
  • Organizer: The 41st Euromicro Conference on Software Engineering and Advanced Applications
  • Place of Presentation: フンシャル市（ポルトガル）
  • Year and Date: 2015-08-26
  • Int'l Joint Research
• [Presentation] オープンソース開発における開発者ごとでのコメント記述の傾向に関する調査 (2015)
  • Author(s): 中野貴史，佐々木隆志，川原稔，阿萬裕久
  • Organizer: 電子情報通信学会ソフトウェアサイエンス研究会
  • Place of Presentation: 札幌市教育文化会館（北海道札幌市）
  • Year and Date: 2015-07-22
• [Presentation] Empirical Analysis of Fault-proneness in Methods by Focusing on their Comment Lines (2014)
  • Author(s): Hirohisa Aman, Sousuke Amasaki, Takashi Sasaki and Minoru Kawahara
  • Organizer: 2nd International Workshop on Quantitative Approaches to Software Quality (QuASoQ2014)
  • Place of Presentation: 済州島（韓国）
  • Year and Date: 2014-12-01 – 2014-12-04
• [Presentation] Empirical analysis of comments and fault-proneness in methods: can comments point to faulty methods? (2014)
  • Author(s): Hirohisa Aman, Sousuke Amasaki, Takashi Sasaki and Minoru Kawahara
  • Organizer: 8th ACM/IEEE International Symposium on Empirical Software Engineering and Measurement (ESEM2014)
  • Place of Presentation: トリノ（イタリア）
  • Year and Date: 2014-09-18 – 2014-09-19
• [Presentation] Mutistage Growth Model for Code Change Events in Open Source Software Development: An Example using Development of Nagios (2014)
  • Author(s): Hirohisa Aman, Akiko Yamashita, Takashi Sasaki and Minoru Kawahara
  • Organizer: 40th Euromicro Conference on Sotware Engineering and Advanced Applications (SEAA2014)
  • Place of Presentation: ベローナ（イタリア）
  • Year and Date: 2014-08-27 – 2014-08-29
• [Presentation] How Developers Comment on Code Smell? An Empirical Analysis on Feature Envy (2014)
  • Author(s): Sousuke Amasaki, Tomoyuki Yokogawa, Risa Fujii and Hirohisa Aman
  • Organizer: 40th Euromicro Conference on Sotware Engineering and Advanced Applications (SEAA2014)
  • Place of Presentation: ベローナ（イタリア）
  • Year and Date: 2014-08-27 – 2014-08-29
• [Presentation] コードの不吉な匂いとコメント文の関連性について (2013)
  • Author(s): 藤井 里沙, 天嵜 聡介, 阿萬 裕久
  • Organizer: ソフトウェア信頼性研究会 第9回ワークショップ
  • Place of Presentation: 愛媛大学
• [Presentation] ソフトウェアメトリクスとその関連分野の研究動向について (2013)
  • Author(s): 阿萬 裕久
  • Organizer: 電子情報通信学会知能ソフトウェア工学研究会
  • Place of Presentation: 愛媛大学
  • Invited
• [Presentation] 小規模プログラムにおけるコメント行数とフォールト潜在性の関係に関する調査 (2013)
  • Author(s): 阿萬 裕久
  • Organizer: 電子情報通信学会ソフトウェアサイエンス研究会
  • Place of Presentation: 香川大学
• [Presentation] コメントの記述位置の違いに着目したフォールト潜在性の分析 --メソッドの前に書かれるコメントとメソッドの中に書かれるコメント-- (2013)
  • Author(s): 阿萬 裕久
  • Organizer: 情報処理学会ソフトウェアエンジニアリングシンポジウム2013併設ワークショップ
  • Place of Presentation: 東洋大学
• [Presentation] メソッドの中に書かれるコメントと前に書かれるコメントのフォールト潜在予測に関する定量的考察 (2013)
  • Author(s): 阿萬 裕久
  • Organizer: 日本ソフトウェア科学会第20回ソフトウェア工学の基礎ワークショップ
  • Place of Presentation: 石川県加賀市
• [Remarks] 研究用ツール | 研究 | ソフトウェア工学研究室
  • URL: http://se.cite.ehime-u.ac.jp/tool/index-j.html
• [Remarks] Tools | Research | Software Eng. Lab.
  • URL: http://se.cite.ehime-u.ac.jp/tool/