The OpenNET Project / Index page

[ новости /+++ | форум | теги | ]



"Google представил инициативу по стимулированию написания док..."
Версия для распечатки Пред. тема | След. тема
Форум Разговоры, обсуждение новостей
Исходное сообщение [ Отслеживать ]
Присылайте удачные настройки в раздел примеров файлов конфигурации на WIKI.opennet.ru.
. "Google представил инициативу по стимулированию написания док..." +/
Сообщение от Аноним (60), 14-Мрт-19, 10:20 
>>> Ты путаешь тёплое с мягким. Doxygen — это техническая документация по API
>>> кода. Season of Docs же предназначен для пользовательской документации. Это два
>>> существенно различных вида документации. Например, doxygen никак не поможет пользователю
>>> GIMP узнать как создать альфа-канал и применить по нему фильтр.
>> Иначе говоря, в коде GIMP упомянутая операция никак не документирована.
> Пользователь (не разработчик!) по коду не сможет понять, как эту опцию использовать.
> Да и вряд ли её вообще там найдёт.

Так doxygen находит и формирует документацию. Другое дело, если комментарии в коде касаются лишь сигнатур функций, расшифровывая сокращённые имена и дублируя код, но не описывают доступным языком что же программа на самом деле делает, то да, в итоге пользователю читать оказывается нечего.

Ответить | Правка | Наверх | Cообщить модератору

Оглавление
Google представил инициативу по стимулированию написания док..., opennews, 11-Мрт-19, 23:23  [смотреть все]
Форумы | Темы | Пред. тема | След. тема



Партнёры:
PostgresPro
Inferno Solutions
Hosting by Hoster.ru
Хостинг:

Закладки на сайте
Проследить за страницей
Created 1996-2024 by Maxim Chirkov
Добавить, Поддержать, Вебмастеру