PHP / C / C ++ - Как выглядит ваш начальный блок комментариев в ваших программах?

Question

Я нахожусь в большом проекте, и в моей программе пока нет комментариев к заголовкам. Я только начал использовать SVN для проекта на днях. Я хочу добавить SVN-тег $ id $, но пока не определился со стандартным комментированием.

Итак, мой вопрос ко всем здесь: как выглядит ваш начальный блок комментариев во всех ваших программах?

т.е:

/***************************************
* myProgram.c 
* revision: $id$
***************************************/

Answer 1

Я не использую один. Мне не нужен

Answer 2

Я лично использую те же комментарии, что и javadoc из них

/**
 * Your comment here 
 */

Answer 3

Это зависит, но мне не нравится, если они слишком причудливы. Что-то вроде этого мне достаточно:

/*
 * file.c
 *
 * Description:
 *
 * History:
 *
 * 
 */

Все более сложное просто раздражает.

Answer 4

Любой начальный блок комментариев является пустой пробелкой, если у вас есть программное обеспечение для отслеживания версий.

Answer 5

Посмотрите на эти вопросы:

• Вы добавляете информацию в начало каждого файла .hpp / .cpp?
• Действительно ли верхний и нижний колонтитулы в вашем коде действительно необходимы?
• Наилучшая практика для комментариев в исходных файлах Java?

Answer 6

Если я пишу какую-то программу с открытым исходным кодом, я обычно добавляю лицензию BSD, в противном случае нет стандартного комментария к заголовку.

Answer 7

Фирменный образец авторских прав + автор / владелец файла и небольшой раздел, если это необходимо (например, когда файл содержит коллекцию небольших связанных классов с собственными заголовками)