Правила оформления исходного кода Delphi MIS3 — различия между версиями

// Редактор стандарта
// Author: Zhukov

{**************************************************************************}
{                                                                          }
{       Название проекта.                                                  }
{  Пример оформления исходного когда для комментариев Doc-O-Matic 6 Express}
{  Author: Zhukov                                                          }
{       ## Copyright (C) 2014 Oblteh                                       }
{       ## Комментарии  Doc-o_Matic                                        }
{**************************************************************************}
// History:
// <table>
//   2014.07.04   Zhukov   Сделал нашлепку которая прерывает при фетче датасета
//   2014.07.04   Ivanov   Создал модуль
// </table>
// ## Пример оформления истории изменений в таблице
// ## Историю можно писать простыми комментариями
unit uTemplate;

interface
  procedure Test1;
  procedure Test2(Param1:Integer; Prama2: String);
  function Test3(S:String) : Integer;

implementation

//Простое описание процедуры
procedure Test1;
begin

end;
//------------------------------------------------------------------------------
// Description: Возвращает дату первого числа квартала, который больше квартала
//              переданной даты на число, здесь показан только пример. В описании
//              слова можно выделять <B> жирным </B>, <I> наклонным </I>,
//              <u>подчеркнутым</u>, кусок кода: <c> begin end  </c>,
//               <sub> subscript</sub>or<sup>superscript</sup>
//     Author: Zhukov
// Parameters: Param1 - дата квартала. Типы параметров Doc-O-Matic добавит сам
//             Prama2 - количество добавляемых кварталов
//    Returns: Дату первого числа квартала
procedure Test2(Param1:Integer; Prama2: String);
begin

end;
//------------------------------------------------------------------------------
//      Short: Пример развернутого описания функции.
//Description: Это премер еще одного описания функции. Можно вставить таблицу:
//              <table>
//                 заголовок 1      заголовок 2
//                 -----------      -----------
//                 строка 1         Строка 1
//                 строка 2         Строка 2
//              </table>
//               Можно вставлять список:
//             * Список
//             * Список
//             * Список
//     Author: Zhukov
//    ## Date: 09.06.2008 11:22:47
// Parameters: S - в функцию передаем строку.
//    Returns: Количество символов в строке.
//   Examples:
//             <code lang="pascal">
//               a := Test3('АБВГДЕ');
//             </code>
//       Note: Эта функция не работает.
//   Glossary: Test3
//       TODO: Написать тело процедуры.
function Test3(S:String) : Integer;
begin

end;

end.