Классы, методы и поля должны иметьXML-комментарии, а как это должно выглядеть в Delphi? << На главную или назад  

19 ответов в теме “Классы, методы и поля должны иметьXML-комментарии, а как это должно выглядеть в Delphi?”

1. 7
   Дмитрий Захаров ответил:
   3 февраля 2008 в 21:05

   Так в задании написано. Напишите калькулятор, но чтобклассы, методы и поля имели XML-комментарий. При этом средство разработки не указано. Я на Делфи работаю, вот и сабж вылился сопсно.

2. 6
   Ванько Родригез ответил:
   3 февраля 2008 в 21:05

   Ну раз не указано, то теги любые. Лишь бы по смыслу подходило

3. 5
   Ванько Родригез ответил:
   3 февраля 2008 в 20:00

   Хорошо, пойдем с другого края. За каким тебе ваще нужны XML-коментарии?

4. 4
   Дмитрий Захаров ответил:
   3 февраля 2008 в 19:05

   Пля, так как мне понять какие тэги ставить?

5. 3
   Ванько Родригез ответил:
   3 февраля 2008 в 17:05

   Теги-то XML, но сами по себе они ничего не значат. Их должен понимать тот, кто будет читать (человек или программа).

6. 2
   Дмитрий Захаров ответил:
   3 февраля 2008 в 17:01

   Гм, спасибо, но как это выглядит в Delphi стиле?

   //<summary>
   // установка имени
   //</summary>
   // <param name="name">имя, которое будет установлено</param>
   function setName(name: String): integer;

   Так, что ли? <summary> и <param> это тэги ХМЛ? Я просто в ХМЛ вообще не шарю. Каким образои тэги зависят от комментируемого куска?

7. 1
   Ванько Родригез ответил:
   3 февраля 2008 в 15:04

   Ну в принципе же предполагается, что потом их будет обрабатывать некая утилита, типа джавовской JavaDoc? Тогда писать нужно в формате этой утилиты. А если нет (тогда, собсно, зачем?), то писать как угодно. Например в C#-стиле:

   ///<summary>
   /// установка имени
   ///</summary>
   /// <param name="name">имя, которое будет установлено</param>
   function setName(name: String): integer;