Правила программирования на С и С++. Главы 1-6 - Не располагайте комментариев между именем функции и открывающей скобкой

ОГЛАВЛЕНИЕ

 

31. Не располагайте комментариев между именем функции и открывающей скобкой.

Основная сложность в следующем примере:

foo( int x )

/* Не помещайте

* комментарий

*/ здесь.

{//...

}

заключается в том, что тело функции может оканчиваться на следующей странице или не помещаться на одном экране. То есть читающий не может сказать, видит ли он прототип или действительное определение. Поместите этот комментарий или до имени функции, или вставьте его в тело функции ниже открывающей скобки: /* Или помещайте

** его здесь.

*/

foo( int x )

{

/* или здесь,

** с таким же отступом, что и программа.

*/

}