ナンプレ(数独)問題作成プログラム その11
doxygen
一度Javaをやった人間は javadoc のようなドキュメントがないとなんとなく不安になる。Doxygen: Main Pageはjavadocのようなことをいくつかの言語を対象にやってくれるソフトである。
これまでのアルゴリズムを使って問題を解くプログラム solve.c を書き、solve.c 以外の .c ファイルにdoxygenコメントをつけた。そのファイルはMSaito/NumPl · GitHubにある。コメント付けるだけで疲れ果てた。かなりいい加減なコメントなのに。いや、まだ solve.c にコメントつけてない。
doxygen のコメントはヘッダファイルの関数宣言につけるべきか、それとも.cファイルの関数定義につけるべきかと考えると、通常ならば見られる可能性の高いヘッダファイルに付けた方がよいと思う。しかし、今回はプログラムの解説をしているので、プログラムを読む人の立場を考えて .c ファイルにつけた。まだ doxygen はかけていないので、エラーもあるはず。
solve は make solve でコンパイルできる。しかし、実行していない。実行してしまうと、コメントを付けるより先にバグを取ろうとしてしまうから。そうなるといつまでたってもコメントが付けられない。
バグ
昨日書かなかったけれど、ナンプレ練習にバグがあり修正した。
読んでいる本
「巨獣めざめる」面白い。けどなかなか読む時間が作れない。
巨獣めざめる (上) (ハヤカワ文庫SF)
巨獣めざめる (上)