Doxygen対応Cプログラムコメント記述例ご紹介

弊社でのC言語で開発を行うプロジェクトでは、ソフトウェア詳細設計書にDoxygenで出力したデータを用いるため、必要な情報を出力するためのコメント記述をしております。

今回は弊社で用いるタグコメントの書き方について紹介させて頂きます。

実際にはDoxygenのオプション設定などにより別の記述もございますので、詳しくはDoxygenのサイトを参照頂ければと思います。

この投稿の続きを読む »

タグ


2012年8月26日 | コメントは受け付けていません。|

カテゴリー:技術情報

Xilinx SDKでのcppcheckを使用する方法

弊社ではC/C++用の静的解析ツールの一つとしてcppcheckを活用しています。

そこで、今回はXilinx Software Development Kit(以後、Xilinx SDKと呼びます)でcppcheckを使用する方法をご紹介します。
Xilinx SDKはXilinx社より提供されているEclipseベースのソフトウエア開発環境です。
cppcheckをEclipseで使用する場合は、”cppcheclipse”というプラグインをインストールします。”cppcheclipse”はEclipseマーケットプレースから簡単にインストールすることができます。
しかし、Xilinx SDKでは、Eclipseマーケットプレースがメニューにありませんので、インストール手順を紹介します。
※cppcheckはすでにインストールされているものとして記載いたします。

この投稿の続きを読む »

タグ


2012年7月31日 | コメントは受け付けていません。|

カテゴリー:技術情報

Doxygenを利用したソフトウェア詳細設計書の作成

弊社ではソフトウェア詳細設計書の作成時にDoxygenによる自動生成された情報を活用しております。

これはDoxygenを用いる事で以下のメリットを得ることが期待できるためです。

  • コードに設計内容が埋め込まれているため、コードと設計書の乖離が軽減され保守性が向上する
  • コメントにDoxygenに対応したタグを埋め込むだけなので低コストで詳細設計書が作成可能である
  • 関数の呼び出し関係や、ヘッダの依存関係図の生成、各種情報へのハイパーリンクの設置など詳細設計書としての内容も高品質である
  • ドキュメント生成時に引数説明の記述もれ等の問題があれば指摘されるため、単純ミスが軽減され設計書の品質が向上する
  • 記載内容などが属人的にならずに設計書の品質が安定する
また、ソフトウェアの基本設計時にDoxygenに対応した簡素なプロトタイプのコードを作成する事で、設計の妥当性などの確認を行うことも可能であり、低コストで後工程での手直しを軽減する効果が期待できます。

この投稿の続きを読む »

タグ


2012年4月3日 | コメントは受け付けていません。|

カテゴリー:技術情報

このページの先頭へ

イメージ画像