非常に奇妙です:コード内のコメントの使用法について誰も言及していないとき、あなたは読みやすさについて話しています:
if (somecomplicated_function() || // let me explain what this function does
someother_function()) // this function does something else
...
その上で、私は常に関数の前に、関数自体について、その入力と出力についてのいくつかのコメントを付けています。
/*---------------------------*/
/*! interpolates between values
* @param[in] X_axis : contains X-values
* @param[in] Y_axis : contains Y-values
* @param[in] value : X-value, input to the interpolation process
* @return[out] : the interpolated value
* @example : interpolate([2,0],[3,2],2.4) -> 0.8
*/
int interpolate(std::vector<int>& X_axis, std::vector<int>& Y_axis, int value)
明らかに、コメントに使用するフォーマットは開発環境(Visual Studio、EclipseでのJavaDocなど)によって異なる場合があります。
SCEに関する限り、これは次のことを意味します。
bool b1;
b1 = somecomplicated_function(); // let me explain what this function does
bool b2 = false;
if (!b1) { // SCE : if first function call is already true,
// no need to spend resources executing second function.
b2 = someother_function(); // this function does something else
}
if (b1 || b2) {
...
}