Исходные файлы

Организация файлов. Идентификационный комментарий

Идентификационный комментарий не является обязательной частью оформления программы и, в случае небольших проектов, может быть опущен. Это первая составляющая программного модуля. В комментарии может находиться информация о содержании модуля (программы) и заметка об авторском праве. Пример оформления комментариев представлен ниже:

{*******************************************************}
{                                                       }
{       Widgets Galore                                  }
{                                                       }
{       Copyright (c) 1995,98 Your Company              }
{                                                       }
{*******************************************************}

Заметка об авторском праве (в стиле Borland) должна содержать, как минимум, следующую информацию:

Copyright (c) yearlist CopyrightHolder.

Вместо yearlist следует указать список лет c датами выхода или обновления продукта. CopyrightHolder - поле для названия субъекта авторского права.

Если вы third party разработчик, не имеющий прямого отношения к продуктам Borland, комментарий можно оформить данным образом:

{*******************************************************}
{                                                       }
{       Borland Delphi Visual Component Library         }
{       Copyright (c) 1995,99 Borland International     }
{       Created by Project JEDI                         }
{                                                       }
{*******************************************************}

После заметки об авторском праве следует указать имя (название организации) разработчика.

Примечание:
Комментарий может быть оформлен не только в Embarcadero/Borland-стиле, но и согласно правилам, установленным разработчиком. Однако в таком случае должна соблюдаться договоренность, аналогичная используемой при именовании файлов: стиль комментария не должен различаться в рамках одного проекта или группы проектов.

results matching ""

    No results matching ""