Скачать: CL | DM;

Delphi, механизм документирования кода   Найти похожие ветки 

← →
Eraser ©   (2007-09-26 23:33) [0]

Есть ли какие-либо эксперты или может встроенные средства реализующие сабж.
Поясню, под механизмом документирования кода я имею ввиду возможность указывать в специально сформированных комментариях, к примеру, описание метода/класса, предназначение параметров и т.п.
к примеру в zend studio это реализовано так

/**
 * Метод для отображения формы заказа для печати.
 *
 * @param int $order_id идентификатор заказа
 */
function PrintOrder($order_id)
{
   // Код
 }
т.е. печатем /** и нажимаем Enter - далее автоматически появляется шаблон, в котором можно указать описание и тип параметров. Это все автоматически подвязывается в IDE и системе состоваления документации по API.

В MSVS2005 примерно так
namespace ClassEmployee
{
 /// <summary>
 /// Class Employee содержит данные о служащих.
 /// Идентификационный номер ID - <see cref="int"/> целое
 /// Фамилия name - <see cref="string"/> строка
 /// </summary>
 public class Employee
 {
   /// <summary>
   ///  Идентификационный номер служащего
   /// </summary>
   int ID;
   /// <summary>
   /// Фамилия служащего
   /// </summary>
   string name;
   /// <summary>
   /// Конструктор класса Employee(int ID, string name).
   /// <param name ="ID">ID номер является целым</param>
   /// <param name ="name">name является строкой</param>
   /// </summary>
   public Employee(int ID, string name)
   {
     this.ID = ID;
     this.name = name;
   }
   /// <summary>
   /// Конструктор без параметров класса Employee.
   /// </summary>
   /// <remarks>
   /// <seealso cref="Employee(int,string)"/>
   /// </remarks>
   public Employee()
   {
     ID = -1;
     name = null;
   }
 }
}

Имеется ли что-то подобное для Делфи? В принципе даже подвязка к вcтроенной подсказке не обязательна.

---

← →
Суслик ©   (2007-09-26 23:35) [1]

смотря какой дельфи
в 2006 и 2007 также как в студии

---

← →
Eraser ©   (2007-09-26 23:46) [2]

> [1] Суслик ©   (26.09.07 23:35)

попробовал, никакого эффекта или автоматизации, просто обычный комментарий, который ручками писать надо. может где-то опцию какую-то активировать нужно.
PS delphi 2007 for win32.

---

← →
Суслик ©   (2007-09-27 00:07) [3]

а, если ты об автоматизации ввода комментария, то этого нет.
есть только сборка при компиляции.

наверное нужно искать сторонние эксперты.

---

← →
имя   (2007-10-07 22:11) [4]

Удалено модератором

---

← →
имя   (2007-10-07 22:25) [5]

Удалено модератором

---

Страницы: 1 вся ветка

Скачать: CL | DM;



Память: 0.46 MB
Время: 0.012 c