Главная страница
    Top.Mail.Ru    Яндекс.Метрика
Форум: "Прочее";
Текущий архив: 2007.11.04;
Скачать: [xml.tar.bz2];

Вниз

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 вся ветка

Форум: "Прочее";
Текущий архив: 2007.11.04;
Скачать: [xml.tar.bz2];

Наверх




Память: 0.45 MB
Время: 0.038 c
6-1172567282
paradox01
2007-02-27 12:08
2007.11.04
Файл через сокет


2-1192108994
Николай
2007-10-11 17:23
2007.11.04
как определить сколько оперативной памяти осталось


4-1177749589
R.O.O.T
2007-04-28 12:39
2007.11.04
Управлять TMainMenu TPoupMenu удаленного приложения


3-1182619806
vegarulez
2007-06-23 21:30
2007.11.04
Ошибка при записи в БД (ругань на ; в конце строки)


15-1191393493
Lex_!
2007-10-03 10:38
2007.11.04
Использование .NET 3.x





Afrikaans Albanian Arabic Armenian Azerbaijani Basque Belarusian Bulgarian Catalan Chinese (Simplified) Chinese (Traditional) Croatian Czech Danish Dutch English Estonian Filipino Finnish French
Galician Georgian German Greek Haitian Creole Hebrew Hindi Hungarian Icelandic Indonesian Irish Italian Japanese Korean Latvian Lithuanian Macedonian Malay Maltese Norwegian
Persian Polish Portuguese Romanian Russian Serbian Slovak Slovenian Spanish Swahili Swedish Thai Turkish Ukrainian Urdu Vietnamese Welsh Yiddish Bengali Bosnian
Cebuano Esperanto Gujarati Hausa Hmong Igbo Javanese Kannada Khmer Lao Latin Maori Marathi Mongolian Nepali Punjabi Somali Tamil Telugu Yoruba
Zulu
Английский Французский Немецкий Итальянский Португальский Русский Испанский