例

Euclid

ユークリドの互除法を用いて2つの自然数の最大公約数，および，最小公倍数を求める．
この例題のような任意の整数を掛け算の積に分解する操作は，安全な通信技術(暗号化と復号化)で重要な役割を果たしている．

処理の手順

2つの自然数(正の整数)の値を読み込む
ユーグリッドの互除法を用いて最大公約数を求める
上で求めた最大公約数をもとに最小公倍数を求める
結果を書き出す

main関数

その他の関数

上記のソースプログラムにドキュメントを書き加えたものも含めて，作成した全てのファイルを以下に示す．

全体は，1つのヘッダファイル(sub.h)， 2つのソースファイル(euclid.c, sub.c)，および，Makefileで構成される．
また，makeコマンドをにより最終的に作成する実行ファイルを euclid とする．この関係を下図に示す

Makefile

sub.h

euclid.c

sub.c

コメントの説明

コメントについては，ここを参照のこと

ソースファイル euclid.c および sub.c 内にコメントとして書き入れたドキュメントを以下で説明する．


/**

      ...

*/

このコメント内にドキュメントを記述する


@file euclid.c

このファイルのドキュメントを以下に示す


@brief ユーグリッドの互除法を用いて，...

「@brief」に続いて要約を記述する．必要に応じて，次の行以下に詳しい説明を書き入れる．
この例のようにコマンドと呼ばれる予約された語があり， Doxygenにより，対応した形式のドキュメントに変換される．
コマンドは「@」あるいは「\」で始まる．


@author 工芸太郎

著者


@date  2008/04/01   Ver. 1

日付とバージョン情報


/**
   @brief ２数の最大公約数,および，最小公倍数を求める

   ユーグリッドの互除法を用いて最大公約数，最小公倍数を求める

   ...
*/
main(int argc, char **argv) {

main関数に対するドキュメント部分

   - 使用方法:   euclid  n m
   - 最大公約数の性質
       - ２数を n, m (n>=m)とし，その最大公約数を gcm(n,m) と表す．<br>
       このとき，gcm(n,m) = gcm(m,n%m) が成立する．<br>
       ただし，n%m は nをmで割った余りを意味する．
   - ユークリッドの互除法
       - n を m で割った余り r1 を求める (m > r1 >= 0)
       - m を r1 で割った余り r2 を求める (r1 > r2 >= 0)

「-」を用いて表を作成する
表についての説明はここをクリック

Doxygenにより作成したドキュメント

[top | back | next ]

学科< 研究室< 授業