매우 이상합니다. 아무도 코드 내에서 주석 사용을 언급하지 않을 때 가독성에 대해 이야기하고 있습니다.
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) {
...
}