KDevelop @ Blog - Linux Life

コメントを多言語で書く

2005/07/27 ( n ) < Doxygen KreetingKard KDevelop >

src/kkglobal.h を追加し、以下の内容を記述

#if defined DOXY_LANG_JA
/**
* DOXY_LANG_XX マクロは APIドキュメントのコメントの言語を切替えるスイッチです。
* DOXY_LANG_JA を定義すると、コメントが日本語になります。(Doxygen自体の言語とは関係ありません。)
* なにも定義しない場合は英語になります。
*/
#elif defined DOXY_LANG_XX
/**
* Other language
*/
#else
/**
* DOXY_LANG_XX macro is switch of language that comments API document.
* For example, DOXY_LANG_JA difinition outputs japanese comments.
* No DOXY_LANG_XX is defined, english comments is output.
*/
#endif
#define DOXY_LANG_XX

この部分は KDevelop での表示がカラフルになって、思っていたよりずっと素晴らしい感じ。

#define DOXY_LANG_JA

をこのファイルの先頭に記述するとAPIドキュメントのコメントが日本語で出力され、この定義をコメントアウトすると英語に切り替わることを確認した。

#include <kdebug.h>
#include <klocale.h>

もほとんどのファイルに記述してあるのでこのファイルに移動しよう。
//TODO 全てのヘッダファイルに kkglobal.h をインクルードする。

日本語入力

2005/07/26 ( n ) < KDevelop 日本語入力 >

KDevelop で skim + uim-anthy で日本語を入力していると 10秒くらいでキャンセルされる。
エディタが何かしてるのかな？
すばやく変換をしてなんとかかんとか書いたが、あきらめてそこだけ他のエディタで書いた方が多分早い。

ソースにコメントを書く

2005/07/21 ( n ) < KDevelop KreetingKard Doxygen >

KMyMoneyというのが気になって色々見ていたら、
KMyMoney Main Page for API documentation.なんてものが存在する。
ちゃんとコメントを書いていてとても偉いと思ったので、KreetingKardにも採り入れることにした。

/**
* 説明
* …
* @short 短い説明
* @param パラメータ名説明
*/

みたいな感じに書いておけば、KDevelopの「ビルド(I)」>「API ドキュメントをビルド」で自動的に作れるらしい。
詳しい設定は「プロジェクト(P)」>「Project Options...」>「Doxygen」でする。
「Doxyfile」というファイルが設定ファイルで、cvs には登録しない雰囲気。
とりあえず、debug フォルダは除いておいた。

詳しい書き方とかはソースとドキュメントを見比べて勉強しよう。

他にも KMyMoney は Project Handbook もちゃんと作ってるし、
その中には Appendix C. Unit Test Examples なんて項目もあって、勉強になる。