関数ヘッダにおける、引数のIN/OUT区分の書き方

ソフトウェアの開発がC言語を使って行われていた頃から、関数の説明をコメントで記述した、関数ヘッダを付けることが、強く推奨されていました。 関数ヘッダには、関数の役割や、引数の意味、作成者や最終更新日時とともに、それぞれの引数が、関数に値を渡すためのもの(IN)か、それとも、関数から値を受け取るためのもの(OUT)かを区別するための、IN/OUT区分も明記するのが一般的です。 IN/OUT区分は、関数の利用者が、関数の呼び出しによって引数に渡したデータが書き換えられるかどうかを判断できるので、非常に有用な情報です。しかし、[IN]と[OUT]の違いについて明確に定義されておらず、混乱が見られることもあります。また、内容を書き換えない時にポインタにきちんとconst修飾子を付ければ、[IN][OUT]の区別は必要ない、という考えも耳にします。 C言語に代わって、オブジェクト指向言語であるC++

[co-ro]

[C/C++]