Глава 5. Соглашения об именах и комментариях ____________703

Использование комментариев для облегчения понимания исходного текста

Комментарии во всех языках программирования призваны помочь исчерпывающе документировать исходный текст программ. Например, если вы имеете дело с небольшим проектом, не изобилующим печатными руководствами, то комментарии в программе могут оказаться единственным средством документирования. Тем более в С и C++, где хорошо оптимизированный .код нередко выглядит весьма загадочно, комментарии могут помочь в его расшифровке.

К примеру, вам попалась программа, преобразующая пары имя/фамилия по следующему принципу:

(фамилия-1, имя-1) (фамилия-2, имя-2) ... (фамилия-п, имя-п)

В ВИД

имя-1 фамилия-1, имя-2 фамилия-2, ... and имя-п фамилия-п

То есть, например

(Washington, George) (Adams, John) (Jefferson, Thomas)

преобразуется в форму

George Washington, John Adams and Thomas Jefferson

Для нашего примера мы упростим эту функцию так, чтобы она обрабатывала только одну пару (фамилия, имя).

Естественно, какие-либо комментарии опускаем. Нормальный программист на С редко использует функции библиотеки строк, предпочитая организовывать все поиски символов самостоятельно через указатели. Результат будет иметь довольно загадочный вид (что одинаково часто случается как в С, так и в C++):

void ConvertInternalNameToFirstLast(char *string; char *result) (

char *p;

-"result =.'\0' ;

while (*string && *string != '(') {

string++;

)

if (*string == '\0') return;

p = ++string;