こんにちは
今日もソフトウェアについてほのぼのと記載します。
現在、他社が書いていてエンドユーザが指摘していたソースを、私が所属している
会社がメンテナンスしている状況です。
指摘事項のうち、ヘッダファイルの扱いが参考になりました。
・ヘッダファイルはユーザに公開している仕様書のようなものです。
ということです。
お客さんはこのヘッダファイルだけ見てくださいね。
といった使い方を想定しているそうで、
内部処理は、ユーザーに意識させない造りにする必要があるとのことです。
仕様書にも、お客さんはこの章だけみてくださいね。
ということのようです。
基本的といえば基本的ですが、為になります。
こんにちは
今日もソフトウェアについてほのぼのと記載します。
現在、納品したソフトに対して、
量産版の為に設計をカスタマイズしています。
ソースの書き方で指摘を受けたのでメモします。
関数の戻り値が1つしかないならvoid型にしてください。
残念ながら、今まで戻り値はvoidで定義することは殆どありませんでした。
エラーコードを必ず返すように作り込んでいて、
後々ソースを変更した時にエラーコードが追加されるかも。
と言ったことを意識していた為です。
ユーザに伺ったところ、以下のような意図があるようです。
可読性で見ると、戻り値がvoidなら中身を見ずに済む
確かに、関数の中を追うのを考えると
手間かもしれませんね。
こんにちは
今日もソフトウェアについてほのぼのと記載します。
今は、納品したソフトに対して、
量産版の為に設計をカスタマイズしています。
ソースコードレビューをお客さんと行ったのですが、
可読性を特に意識されていて、
それぞれの処理にコメントを入れてくださいとのことでした。
これ、結構衝撃的でして、、、、
私の所属しているソフトの人たちはソースを見て
分からない人が悪い！
そんなのも分からないのか。と言う伝統があったので、
新鮮でした。
確かに、処理を追う際にコメントが一言書いてあるだけでも
不具合があった場合、問題の箇所を探しやすくなりますね。
