手離れのいい外部仕様を作成しよう - Qiita

プログラムの開発を分業して行っていて気づいたことがある。新たに加わった人がメンテナンスしやすいモジュールと、そうでないモジュールとがあることだ。メンテナンスしやすいモジュールでは、加わったその日にコードの改善が可能である。そうでないモジュールでは、数ヶ月たっても、近寄りがたいものとして意識され続ける。手離れのいい外部仕様を作成して、自分の仕事を減らしていこう。 新たに加わった人がメンテナンスしやすいモジュールの特徴 外部仕様が明確である。 ドキュメンテーションコメントが充実していている。 引数のin, out, inoutの区別が明確である。 @param[in], @param[out] const 属性が可能な引数にはconst 属性がついている。 関数定義の際に、可能な場合には引数を参照渡しを用いている。 単体テストがされている。 include するヘッダファイルの数は抑制されてい

[ismage]

ポケットへ入れた 手離れのいい外部仕様を作成しよう