ソフトウェア開発支援ソフトウェアツールの開発・提供を行う株式会社Sider（本社：東京都品川区、代表取締役社長：浅原明広、以下：Sider）は、自動コードレビューサービス「Sider」に新しい推奨のコーディングガイド（解析ルール）「Recommended Rules」を適用しました。本ガイドは、慶應義塾大学理工学部情報工学科の高田眞吾教授ならびに南山大学理工学部ソフトウェア工学科の名倉正剛准教授との共同研究の成果を基に開発されました。実際の開発で重視されているガイドを抽出しており、コードレビューで開発者にとって有益な指摘だけを得やすくなります。Recommended Rulesは、Siderの初期設定で選択されるコード解析ツールに設定済みです。また、下記サイトからルールの設定ファイルをダウンロードいただけます。
https://help.sider.review/tools/cplusplus/cpplint#recommended-ruleset
コーディングガイドが定めるルールには重要度の差があり、これらを一律に扱ったコードレビューは、チーム・プロジェクトによって重要度の低い指摘が開発のノイズになってしまう場合がありました。Recommended Rulesは、活発に開発されている1000個の著名なオープンソースソフトウェアのソースコードと開発履歴を解析し、実際に守られているコーディングガイドを抽出して得られたルールです。本ルールを適用したことで、Siderの自動コードレビューはノイズが少なく生産性に寄与する重要な指摘だけを受けられるようになります。
Recommended Rulesは、プログラミング言語「C/C++」の解析ツール（cpplint）に設定されています。また、「Java」、「Ruby」、「JavaScript」などの言語でも、近日中に適用する用意があります。その他の言語も順次対応していく予定です。
Recommended Rulesがご利用いただけるプログラミング言語
- C/C++
- Java（近日適用）
- JavaScript（近日適用）
- Ruby（近日適用）
- TypeScript（近日適用）
対応予定のプログラミング言語
- C#
- CSS
- Golang
- Kotlin
- Python
- PHP
- Swift
- Shell script
推奨コーディングガイド提供と研究の背景
コ－ディングガイドはソフトウェアの品質を高く保つために定められ、公開されています。これらルールを守ることで、バグの抑止、可読性の向上、保守性の向上、セキュリティ脆弱性の発生を防ぐなどの恩恵が期待されています。
一方で、それらの様々なコーディングガイドで定められているルールにも重要度の差があります。例えば、「”」と「’」を同等に扱えるプログラミング言語では、原則としてどちらを使うか定めるルールを含むガイドがあります。ルールに従うことで開発チーム間でのソースコード共有がしやすくなったり、どちらを使うべきかといった議論を抑制したりすることが期待できますが、すでに開発されたコードをルールに沿って修正するほどの価値があるかは明瞭ではありません。チーム・プロジェクトによっては、生産性に寄与しないものとして統一しないという意思決定をしていることもあります。
広く普及しているコーディングガイド（コーディングスタイル・コーディング規約など）を全て守ることが生産性に寄与するわけではなく、逆に遵守することに時間を割きすぎてしまい、生産性を下げてしまうこともあります。
こういった背景から、「どのようなプロジェクトであっても有益であるコーディングガイド」としてRecommended Rulesが作られました。本ガイドだけをはじめにプロジェクトに導入し、その後プロジェクトに合わせて必要なルールを追加（有効化）していくことで、プロジェクトにあったガイドの設定と運用が簡単にできるようになります。
Recommended Rulesの作成にあたっては、慶應義塾大学理工学部情報工学科の高田眞吾教授ならびに南山大学理工学部ソフトウェア工学科の名倉正剛准教授と共同で研究しました。研究内容については別途論文等でご紹介をさせていただく予定です。
参考論文・ポスター等
- 倉重 徹, 末次 健太郎, 角 幸一郎, 名倉 正剛, 高田 眞吾, 浅原 明広:
OSS を対象にしたコーディング規約違反発生状況の調査, ソフトウェアエンジニアリングシンポジウム2020（SES2020），ポスター セッション（2020年9月） - 名倉正剛, 田口健介, 高田眞吾:
コーディング規約違反メトリクスに基づきソフトウェア変更に対して不具合混入を予測する手法, 情報処理学会論文誌61巻4号, pp.,895-907（2020年4月）
共同研究先
- 慶應義塾大学理工学部情報工学科高田研究室 高田眞吾教授
- 南山大学理工学部ソフトウェア工学科 名倉正剛准教授
Recommended Rulesについて
推奨コーディングガイド「Recommended Rules」は、慶應義塾大学理工学部情報工学科の高田眞吾教授ならびに南山大学理工学部ソフトウェア工学科の名倉正剛准教授との共同研究を基に、株式会社Siderが開発しました。本ガイドの提供に伴う責任はSiderにあります。
株式会社Siderについて
株式会社Siderは、ソフトウェアアクセラレーションサービスのグローバルリーダーである株式会社フィックスターズから、ソフトウェア開発分野における製品開発企業として、2019年にスピンオフされた会社です。フィックスターズは2002年の創業以来、自動運転、量子コンピューティング、医療機器、金融システム、コンピューターグラフィクスなど、様々な分野におけるグローバル企業・研究機関に強力なソフトウェア高速化ソリューションを提供してきました。これらのクライアントプロジェクトの経験を活かして、株式会社Siderは、自動コードレビューサービスの「Sider」やプロジェクト管理アシスタントツール「Sider Team Insights」を提供しています。株式会社SiderはAIと人とが協調して開発する世界を実現し、あらゆるエンジニアの開発体験を向上させていきます。詳細はこちらをご参照ください（https://siderlabs.com/）。
ニュース一覧へ戻る