Форум программистов
 

Восстановите пароль или Зарегистрируйтесь на форуме, о проблемах и с заказом рекламы пишите сюда - alarforum@yandex.ru, проверяйте папку спам!

Вернуться   Форум программистов > Delphi программирование > Общие вопросы Delphi
Регистрация

Восстановить пароль
Повторная активизация e-mail

Купить рекламу на форуме - 42 тыс руб за месяц

Ответ
 
Опции темы Поиск в этой теме
Старый 13.01.2011, 13:28   #1
veniside
Старожил
 
Регистрация: 03.01.2011
Сообщений: 2,508
По умолчанию доки из исходников

Расскажите, кто чем доки делает. Такие, чтобы комменты из исходников читали, естественно. С JavaDoc совместимые, по-возможности.

Вот, что я пробовал:

DelphiCodeToDoc — в целом неплохо, но глючный и заброшенный. По молодости я его исходники для себя заточил, но сейчас лень ворошить и поднимать всё по-новой.

Doc-O-Matic — .chm нормально, но хочется и вменяемый набор хтмл получить, а то безумие, которое он создаёт, вменяемым никак не назовёшь.

DIPasDoc — игрушка, реально неудобная, не продуманная структура доков. Плюс совместимость с JavaDoc хромает, на сколько я увидел.

Doxygen + pas2doc — ну так.. чисто посмеяться.

JADD — вот это уже что-то, хотя в интерфейсе там конь не валялся, поток мыслей, изложенных в гуе. Но если разобраться, то работает неплохо, кроме одной мелочи, забыл какой.

Платные я не рассматривал, хотя, если результат устроит, купить не проблема. Лень только триалы качать и удалять.
"Когда приходит положенное время, человек перестаёт играть в пинбол. Только и всего."
veniside вне форума Ответить с цитированием
Старый 15.01.2011, 00:39   #2
veniside
Старожил
 
Регистрация: 03.01.2011
Сообщений: 2,508
По умолчанию

Что, никто компонент не создавал своих, что ли? Или такой код, что страшно другим показать? ) Помимо всего прочего это позволяет ещё взглянуть на плоды своей трудовой деятельности свежим взглядом робота.

Ладно, тогда опишу в кратце, как это выглядит, может кому будет интересно.
Все исходники комментятся примерно так:

Код:
const
  c_max_count = 10; /// три слэша подряд превращают коммент в доку для константы c_max_count

type 
  {* <-- эта звёздочка говорит, что наш коммент будет докой
         (в данном случае докой для класса)

    Тут описываем наш класс в произвольной форме.
  }
  myClass = class(TObject)
  public
    {*
       Описываем, что делает метод.

       @param value Описываем, что передаётся этим параметром, что будет при дефолтовом значении и т.д.
       @return Описываем, что именно возвращает функция.
    }
    function CalcSomething(value: Integer = 0): Integer;
  end;
В результате, после прогона документатором получаем во-первых красивую иерархию наших классов, во-вторых быстрый способ навигации между методами, классами, типами, предками, наследниками и проч. Ну и самое главное, это приучает комментировать свой код хотя бы по-минимуму.

В шарпе документатор встроен в компилятор, в Дельфи мы этого хз когда дождёмся. Пичаль.
"Когда приходит положенное время, человек перестаёт играть в пинбол. Только и всего."
veniside вне форума Ответить с цитированием
Ответ


Купить рекламу на форуме - 42 тыс руб за месяц

Опции темы Поиск в этой теме
Поиск в этой теме:

Расширенный поиск


Похожие темы
Тема Автор Раздел Ответов Последнее сообщение
Компонент без исходников lisiserg Общие вопросы Delphi 7 09.09.2010 09:20
Мат в комментах исходников :) Олвин Свободное общение 70 19.07.2010 11:00
Обход конем шахмотной доки Evgeniy21 Помощь студентам 1 28.01.2010 01:16
Пример технического задания и доки в кадре проекта lexluther Свободное общение 1 11.01.2007 12:23