Блочные комментарии

Блочные комментарии используются для описания файлов, методов, структур данных и алгоритмов. Блочный комментарий должен присутствовать в начале каждого файла и перед каждым методом. Также их можно использовать и в других местах: например, внутри методов. Блочный комментарий внутри функции или метода должен быть выровнен по уровню комментированного кода.

Для отделения от остального кода блочный комментарий должен предваряться пустой строкой. Каждая строка блочного комментария, кроме первой, должна начинаться с символа "звездочки" ("*").

/*
* Это блочный комментарий
*/

Блочный комментарий начинается с "/*". Оформление тела комментария не должно изменяться. Пример:

/*
* Это блочный комментарий с весьма специфичным
* оформлением, в котором используются отступы
*
*   один
*       два
*           три
*/

Замечание: Если вы используете отступы, то и блочный комментарий не используйте или пойдите на уступки чтобы другие могли прибегнуть к идентификации вашего кода.