• 今年も出展いたします。ご来場をお待ちしております。

開発の下準備

今までのプロトタイプのソースに、ドキュメント生成用コードの埋め込み作業を行いました。
それは、doxygenに対応するためのコードです。今後紆余曲折も考えられるので、設計段階のドキュメントだけでは完成時のソースと一致しないので、ドキュメント修正にかかる時間を減らすために使用する事にしました。
使い方をあまりよく調べずに埋め込んでいったため、途中で関数の引数の書き方に問題が有る事に気づきました。
気づくまでは、下記(1)のように、一々引数の変数名を書いていました。問題点は、後々変更などをした場合に、コメントの修正忘れが発生する可能性が有る事と、コメント作成に手間がかかる事です。
途中からは、(2)の書き方に変えて進めました。これだとコメントに引数の変数名を書かなくても、ちゃんと引数の変数名を出力してくれて、変数名が変更されれば、そのまま反映されます。
まだ初期段階なので追い追い、(2)のように修正しながら進めて行きます。

(1)初期の書き方
/**
 * @brief サンプルの関数
 * @param[in] ptInp 入力データのポインタ
 * @param[out] ptOut 出力データのポインタ
 * @return bool true=正常 / false=エラー
 */
bool SampleFunc( int *ptInp, int *ptOut )

(2)途中からの書き方
/**
 * @brief サンプルの関数
 * @return true=正常 / false=エラー
 */
bool SampleFunc( int *ptInp,        //!< [in] 入力データのポインタ
                           int *ptOut )      //!< [out] 出力データのポインタ

それとバージョン管理を新たにGitで行い始めました。サブバージョンでもいいのですが、ローカルで管理でき修正履歴が見れるのでこれを使う事にしました。
また、コマンドラインで入力して管理するのは面倒なので、GUIタイプのアプリを使うことにして、GitKrakenを使いはじめました。このアプリも初めて使うので分らないことだらけですが、少しづつ慣れるようにしています。
ただ、現在困っている問題点は、管理下のフォルダーに生成されるコンパイルした中間ファイルなどを管理から除外したいのですが、指定の方法がわからない事です。
除外しないと、とんでもない量の差分ファイルが作成される可能性があります。

一つずつ問題点を解決しながら、完成に近づけていきます。

<2019/4/2加筆>本日実験して、”.gitignore” ファイルを追加すれば、その内容を読んで無視するか判断する事がわかりました。リボジトリ作成時に無視するタイプを指定できたのですが、初めてでわからなかったので、そこは無指定にしていました。まあ、どっちにしても何を選べばいいのかも、よくわかりませんでしたが。

.gitignoreファイルの中身は、無視したいファイル名(例:sample.txt)や拡張子(例:*.o)を1行に1個指定すればいいだけでした。これは、新しいリボジトリを作成する際、無視するタイプを適当に指定して作られた内容を見てわかりました。<加筆終了>



  • 今年も出展します。ご来場をお待ちしております。