戻り値があるメソッド

戻り値をどのように記述するかは、キモの部分です。メソッドのシグニチャ(引数と返数)は情報量が多く、下手に日本語化すると読むのも書くのも難しい文章表現になる可能性があります。例えば

int calc( int a , int b );

というメソッド。当初これを日本語化する時に以下のような記述をしました。

整数型を返し、整数型であるAと整数型であるBを計算するとは{…}

これではあまりにも長ったらしい。そこで現在は以下のように記述することにしています。

A(整数型)とB(整数型)を計算する(整数型)とは{…}である。

型に関する情報は全て括弧に閉じ込めることで多少なりとも読みやすくしたつもりです。でもまだ悩ましいなぁ。