Как подписываем модуль.

[Роман Радер]

Будьте проще))
Тупо в начале

(*  Author: NAME             *)
(*  e-mail: NAME@host.do     *)
(*  site: NAMEsite.do        *)
(*  Description: blablabla   *)
(*  October 27, 2009         *)

В общем, рекомендую почитать книгу ...

О_о... Специально ради того чтобы научится подписывать модули?..)))

[Levsha100]

пециально ради того чтобы научится подписывать модули?..)))

"Чтобы поднять свой уровень до уровня профессионала"(примерно так там написано)
На самом деле там объясняется не КАК делать а КАК ПРАВИЛЬНО делать...

[crazy horse]

Вообще-то автор темы спрашивал о заголовочном блоке модуля, а не о комментариях к коду

Заголовочный блок обязан быть комментарием к коду! Иначе смысла в нем null.

Никак не подписываю, вообще ноль оформления, голый код тупо в столбец.

Напрасно! Настоящие мужики лупят в строку!
Ps. Ну зачем, зачем мне знать кто и когда написал этот код? Все равно это мало кто читает, а кому надо и сам знает, откуда взял. Ладно, оно бы ничего, но это должно дополнять а не замещать комментарии в заголовочном блоке. А копирайты никому не интересны. Это от лукавого.

[AnTe]

Сообщение от JTG

В RadStudio комментарии вида "//TODO: ..." и "//DONE: ..." подсвечиваются другим цветом и автоматически добавляются в ToDo-list. В нём и искать

хм, блин, действительно, и в D7 добавляются.... как я забыл потестировать эту возможность.. всё закладки, закладки....

вот только я не нашёл гор.клавиши, чтобы вызвать todo лист

[AnTe]

Сообщение от Arigato

Если пишу на PHP какой-нибудь класс, то все public методы класса выношу в начало кода в виде комментария, перечисляю методы, аргументы к ним и краткое пояснение, для чего нужен тот или иной метод.
Когда забываешь, какие методы были в классе, открываешь описание класса и сразу видишь краткую справку.

неплохое описание, что делает метод - сама его реализация

наглядный пример - метод Free делфёвского класса TObject. Его описание в справке в несколько раз больше исходного кода

Именно поэтому описание, что делает процедура, я пишу в тексте программы, прямиком возле его объявления в интерфейсной секции. Плюсы:
1. перейти к реализации очень быстро
2. попасть на описание можно, прямо как только собрался её применять, держа контрол и щёлкнув мышой, на строке вызова этой процедуры/метода - делфя отправит прямиком в исходный код.

А в комментарии начала модуля - исключительно его общее предназначение, фамилиё автора. Номер отдела, код проекта, которому он соответсвует - это уже по специфики организации. Так как я в настоящее время программирую один - у меня в заголовках лишь комментарий, "что это такое". И то - не всегда

[Arigato]

Сообщение от AnTe

неплохое описание, что делает метод - сама его реализация

Во-первых, для этого нужно лезть в сам код и искать реализацию метода (это Вам не Делфи).
Во-вторых, не любой метод будет на столько прост, что бы сразу всё понять, а часто нужно не само описание метода, а бывает нужно узнать, какие вообще есть методы в классе. Тогда проще всего, если они перечислены в начале файла.

Сообщение от Levsha100

На самом деле там объясняется не КАК делать а КАК ПРАВИЛЬНО делать...

На самом деле, то, как именно комментируется не говорит о том, какой квалификации программист. Можно разработать свою систему комментариев, и свой генератор документации по ним.
И, при этом, я видел кодеров, которые во всю используют стиль:

/**
 *
 */

И только потому, что это круто, хотя, сами по себе они самые настоящие быдлокодеры.

[AnTe]

Сообщение от Arigato

Во-первых, для этого нужно лезть в сам код и искать реализацию метода (это Вам не Делфи).

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

Сообщение от Arigato

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

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

[Роман Радер]

Сообщение от Arigato

И, при этом, я видел кодеров, которые во всю используют стиль:

/**
 *
 */

И только потому, что это круто, хотя, сами по себе они самые настоящие быдлокодеры.

Как ты определил, что они - быдлокодеры, ведь сам писал:

На самом деле, то, как именно комментируется не говорит о том, какой квалификации программист.

???

[Arigato]

Сообщение от Роман Радер

Как ты определил, что они - быдлокодеры, ведь сам писал:

Явно это было определено не по комментариям, а по самому коду.