|
Страница 33 из 93
29. Комментарии должны быть выровнены вертикально.
Выравнивайте начало и конец комментария вертикально в многострочных комментариях. /* Первая строка, * вторая строка, * третья строка. */ Если ваш компилятор их поддерживает, то здесь помогут комментарии в стиле С++: // Первая строка, // вторая строка, // третья строка. Есть две причины появления этого правила, они обе демонстрируются в последующей программе: /********************************************************** void the_function( void ) Это многострочный комментарий, выполняющий все, что должен делать комментарий. К сожалению, отсутствие слева вертикального столбца из звездочек затрудняет зрительное разделение комментария и программы *********************************************************** void the_function( void ) { // далее настоящая функция. code_goes_here(); } /*********************************************************/ Во-первых, заметили ли вы, что я забыл поместить / в конце второй строки звездочек? Таким путем можно запросто терять целые функции. Во-вторых, трудно заметить, где оканчивается комментарий и начинается текст программы. Исправьте обе ошибки следующим образом: /********************************************************** * void the_function( void ) * * Это многострочный комментарий, выполняющий все, что должен * делать комментарий. * * Вертикальный столбец из звездочек слева облегчает * зрительное разделение комментария и программы * *********************************************************** */ void the_function( void ) { // далее настоящая функция. code_goes_here(); } |