プログラムドキュメント作成の難しさ
MCAP-CR型多自由度を含むバスレフ型の力学シミュレータプログラムは、一昨年に完成し、昨年公開しました。
そろそろ次の機能向上を考えていますが、その前に、これはこれで一つの完成形として、ドキュメントを作成しています。
プログラムは、作ったそのときは分かるのですが時間が経つと内容を追うことが難しくなり、ましてや他人が読むのは困難です。
本職のプログラマであれば、おそらくコメントだけで内容が分かるようように作れるのですが、自分のような素人のプログラムは、追っていくのが難しいと思います。
また、内容は、科学技術あるいは工学計算プログラムなので、厳密性が必要です。
そこで、最初に、サブルーチンの一覧と変数の一覧、主要な計算の一覧を作成したまでは良かったのですが..
これだけでは自分も分からないので、フローチャートを書いてみました。
すると、フローチャートが複雑になって余計に良く分かりません。
分岐ブロックが増え、同じことをあちこちに書かなければなりません。
計算オプションを分け、処理を微妙に変えてもその中には共通の処理も多くあります。
書いてみると、正直言って複雑過ぎます。
通常のフローチャート図式を使わずに、自分の書式で作ったほうがいいのかもしれません。
そういえば、フローチャートの記号も複数あるようで、これを使えば絶対、という定型はなさそうに見えます。
皆さん同じように悩んだのでしょうか。
挫折が多過ぎます。
ちょっと頭を冷やして考えてみます。
そろそろ次の機能向上を考えていますが、その前に、これはこれで一つの完成形として、ドキュメントを作成しています。
プログラムは、作ったそのときは分かるのですが時間が経つと内容を追うことが難しくなり、ましてや他人が読むのは困難です。
本職のプログラマであれば、おそらくコメントだけで内容が分かるようように作れるのですが、自分のような素人のプログラムは、追っていくのが難しいと思います。
また、内容は、科学技術あるいは工学計算プログラムなので、厳密性が必要です。
そこで、最初に、サブルーチンの一覧と変数の一覧、主要な計算の一覧を作成したまでは良かったのですが..
これだけでは自分も分からないので、フローチャートを書いてみました。
すると、フローチャートが複雑になって余計に良く分かりません。
分岐ブロックが増え、同じことをあちこちに書かなければなりません。
計算オプションを分け、処理を微妙に変えてもその中には共通の処理も多くあります。
書いてみると、正直言って複雑過ぎます。
通常のフローチャート図式を使わずに、自分の書式で作ったほうがいいのかもしれません。
そういえば、フローチャートの記号も複数あるようで、これを使えば絶対、という定型はなさそうに見えます。
皆さん同じように悩んだのでしょうか。
挫折が多過ぎます。
ちょっと頭を冷やして考えてみます。
by mcap-cr
| 2014-01-25 15:10
| プログラミング
|
Trackback
|
Comments(0)
最新の記事
公金ちゅーちゅーばー |
at 2023-06-01 06:07 |
ひいきのお店が戻っていました |
at 2023-05-31 06:14 |
加古隆のコンサートに行ってき.. |
at 2023-05-29 06:45 |
脳内メモリの呼出し機能 |
at 2023-05-28 09:15 |
オーディオ趣味の2極化 |
at 2023-05-25 08:08 |
耳の自主検査 |
at 2023-05-22 12:23 |
EVどうなるか |
at 2023-05-18 20:14 |
decideとdetermine |
at 2023-05-17 06:57 |
製造元 |
at 2023-05-16 06:09 |
時代遅れ |
at 2023-05-14 07:04 |
I am I |
at 2023-05-12 06:16 |
Me Too |
at 2023-05-09 12:35 |
対数 |
at 2023-05-08 05:58 |
見た目 |
at 2023-05-07 07:48 |
久しぶりのオーディオ |
at 2023-05-06 07:15 |
効率は非効率 |
at 2023-05-05 06:34 |
ちょっとずつ合わない |
at 2023-05-04 13:59 |
Chat GPT使ってみたが.. |
at 2023-05-03 07:33 |
A3複合機注文した |
at 2023-05-01 19:07 |
分からないマニュアル |
at 2023-04-30 09:58 |
以前の記事
2023年 06月
2023年 05月
2023年 04月
2023年 03月
2023年 02月
2023年 01月
2022年 12月
2022年 11月
2022年 10月
2022年 09月
2022年 08月
2022年 07月
2022年 06月
2022年 05月
2022年 04月
2022年 03月
2022年 02月
2022年 01月
2021年 12月
2021年 11月
2021年 10月
2021年 09月
2021年 08月
2021年 07月
2021年 06月
2021年 05月
2021年 04月
2021年 03月
2021年 02月
2021年 01月
2020年 12月
2020年 11月
2020年 10月
2020年 09月
2020年 08月
2020年 07月
2020年 06月
2020年 05月
2020年 04月
2020年 03月
2020年 02月
2020年 01月
2019年 12月
2019年 11月
2019年 10月
2019年 09月
2019年 08月
2019年 07月
2019年 06月
2019年 05月
2019年 04月
2019年 03月
2019年 02月
2019年 01月
2018年 12月
2018年 11月
2018年 10月
2018年 09月
2018年 08月
2018年 07月
2018年 06月
2018年 05月
2018年 04月
2018年 03月
2018年 02月
2018年 01月
2017年 12月
2017年 11月
2017年 10月
2017年 09月
2017年 08月
2017年 07月
2017年 06月
2017年 05月
2017年 04月
2017年 03月
2017年 02月
2017年 01月
2016年 12月
2016年 11月
2016年 10月
2016年 09月
2016年 08月
2016年 07月
2016年 05月
2016年 04月
2016年 03月
2016年 02月
2016年 01月
2015年 12月
2015年 11月
2015年 10月
2015年 09月
2015年 08月
2015年 07月
2015年 06月
2015年 05月
2015年 04月
2015年 03月
2015年 02月
2015年 01月
2014年 12月
2014年 11月
2014年 10月
2014年 09月
2014年 08月
2014年 07月
2014年 06月
2014年 05月
2014年 04月
2014年 03月
2014年 02月
2014年 01月
2013年 12月
2013年 11月
2013年 10月
2013年 09月
2013年 08月
2013年 07月
2013年 06月
2013年 05月
2013年 04月
2013年 03月
2013年 02月
2013年 01月
2012年 12月
2012年 11月
2012年 10月
2012年 09月
2012年 08月
2012年 07月
2012年 06月
2012年 05月
2012年 04月
2012年 03月
2012年 02月
2012年 01月
2011年 12月
2023年 05月
2023年 04月
2023年 03月
2023年 02月
2023年 01月
2022年 12月
2022年 11月
2022年 10月
2022年 09月
2022年 08月
2022年 07月
2022年 06月
2022年 05月
2022年 04月
2022年 03月
2022年 02月
2022年 01月
2021年 12月
2021年 11月
2021年 10月
2021年 09月
2021年 08月
2021年 07月
2021年 06月
2021年 05月
2021年 04月
2021年 03月
2021年 02月
2021年 01月
2020年 12月
2020年 11月
2020年 10月
2020年 09月
2020年 08月
2020年 07月
2020年 06月
2020年 05月
2020年 04月
2020年 03月
2020年 02月
2020年 01月
2019年 12月
2019年 11月
2019年 10月
2019年 09月
2019年 08月
2019年 07月
2019年 06月
2019年 05月
2019年 04月
2019年 03月
2019年 02月
2019年 01月
2018年 12月
2018年 11月
2018年 10月
2018年 09月
2018年 08月
2018年 07月
2018年 06月
2018年 05月
2018年 04月
2018年 03月
2018年 02月
2018年 01月
2017年 12月
2017年 11月
2017年 10月
2017年 09月
2017年 08月
2017年 07月
2017年 06月
2017年 05月
2017年 04月
2017年 03月
2017年 02月
2017年 01月
2016年 12月
2016年 11月
2016年 10月
2016年 09月
2016年 08月
2016年 07月
2016年 05月
2016年 04月
2016年 03月
2016年 02月
2016年 01月
2015年 12月
2015年 11月
2015年 10月
2015年 09月
2015年 08月
2015年 07月
2015年 06月
2015年 05月
2015年 04月
2015年 03月
2015年 02月
2015年 01月
2014年 12月
2014年 11月
2014年 10月
2014年 09月
2014年 08月
2014年 07月
2014年 06月
2014年 05月
2014年 04月
2014年 03月
2014年 02月
2014年 01月
2013年 12月
2013年 11月
2013年 10月
2013年 09月
2013年 08月
2013年 07月
2013年 06月
2013年 05月
2013年 04月
2013年 03月
2013年 02月
2013年 01月
2012年 12月
2012年 11月
2012年 10月
2012年 09月
2012年 08月
2012年 07月
2012年 06月
2012年 05月
2012年 04月
2012年 03月
2012年 02月
2012年 01月
2011年 12月
最新のコメント
> somo_somoさ.. |
by mcap-cr at 19:22 |
帝国データバンク調べで新.. |
by somo_somo at 13:38 |
> somo_somoさ.. |
by mcap-cr at 18:53 |
個人的にはEVの評価はバ.. |
by somo_somo at 15:38 |
> マイクロ・トレーダー.. |
by mcap-cr at 07:52 |
“I’m not any.. |
by マイクロ・トレーダー at 22:43 |
> tincanさん .. |
by mcap-cr at 18:55 |
ハイファイ志向の方はおカ.. |
by tincan at 09:37 |
> tincanさん .. |
by mcap-cr at 17:24 |
マッキンと言えば・・・五.. |
by tincan at 14:54 |
最新のトラックバック
検索
ファン
記事ランキング
画像一覧
イラスト:まるめな