社内勉強会 : Doxygenについての社内勉強会 レポート

目的

1. Doxygenを使用したコードドキュメント生成の基本的な理解を深める。

2. チームでの効率的なコード管理および共有を促進する。

3. プロジェクトのドキュメント品質向上を目指す。

   
   

勉強会の内容

1. イントロダクション

• Doxygenとは何か

  • ソースコードから自動的にドキュメントを生成するツール

  • 主にC++やPython、Javaなどの多言語をサポート

    
    

• 使用のメリット

  • ドキュメント作成の効率化

  • チーム全体でのコード理解の促進

  • opencvのオープンソースはdoxygenを利用しています。

    
    
    
    

2. 基本機能の紹介

• コメント形式とタグ

  • /// や /** ... */ の利用例

  • 主なタグ: @param、@return、@file、@brief など

• Private関数 (関数コメントをドキュメントに反映しないための書き方 (!を入れない）

• Doxygen設定ファイル (Doxyfile) の作成と設定ポイント

3. 実践デモ

• 簡単なプロジェクトを例に、DoxygenのセットアップからHTMLドキュメントの生成までを実演

• ドキュメント化のベストプラクティス

  • 例: 関数・クラスコメントの統一ルール、不要な情報の省略

  
  

• Copilotでdoxygen形式で関数コメントを自動挿入するデモ

• ドキュメントもCI, CDと連携する。

  

  ・doxygenの中にuml ダイアグラムに挿入するデモ

4. 活用事例

• ハチエックスのプロジェクトでの応用方法

  • ROS関連コードのドキュメント化

  • AIアルゴリズムのモジュール設計の共有化

    
    

5. 質疑応答

• 使用時の注意点やトラブルシューティングについての議論

  
  

成果・感想

1. Doxygenの基本操作を理解した。

2. チーム内でのドキュメント作成における統一ルールを定める第一歩を踏み出せた。

3. 今後のプロジェクトでDoxygenを活用し、コードの可読性とドキュメント品質を向上させるための基盤が整った。

   
   

今後の展望

• 各プロジェクトにおいてDoxygenの試験的導入を進める。

• 社内ガイドラインを策定し、Doxygen活用の標準化を目指す。

• 社内ドキュメントの共有プラットフォームを構築し、参照性を高める。