Правила программирования на С и С++. Главы 1-6
Страница 28. Комментарии должны быть предложениями


 

24. Комментарии должны быть предложениями.

Они должны быть хорошо составлены и иметь правильную пунктуацию, по возможности без сокращений. Не превращайте свои комментарии в секретный код, применяя странные сокращения и изобретая свой собственный грамматический строй. Вам также не должна требоваться нить Ариадны для расшифровки комментариев.

 
« Предыдущая статья