The OpenNET Project / Index page

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



Вариант для распечатки  
Пред. тема | След. тема 
Форум Разговоры, обсуждение новостей
Режим отображения отдельной подветви беседы [ Отслеживать ]

Оглавление

Google представил инициативу по стимулированию написания док..., opennews (?), 11-Мрт-19, (0) [смотреть все]

Сообщения [Сортировка по времени | RSS]


7. "Google представил инициативу по стимулированию написания док..."  +5 +/
Сообщение от KonstantinB (??), 12-Мрт-19, 01:56 
Это как раз очевидно:
1) код писать интересно, а документацию писать скучно и лениво - а тем более поддерживать ее в актуальном состоянии;
2) то, что разработчик в своем родном коде считает очевидным, далеко не всегда таковым является, особенно для менее опытных коллег.
Ответить | Правка | К родителю #3 | Наверх | Cообщить модератору

10. "Google представил инициативу по стимулированию написания док..."  +/
Сообщение от Аноним (10), 12-Мрт-19, 07:29 
Не очевидно, так как существует, к примеру, Doxygen, а комментарии это составная часть кода.
Ответить | Правка | Наверх | Cообщить модератору

44. "Google представил инициативу по стимулированию написания док..."  +/
Сообщение от bircoph (ok), 13-Мрт-19, 00:29 
Ты путаешь тёплое с мягким. Doxygen — это техническая документация по API кода. Season of Docs же предназначен для пользовательской документации. Это два существенно различных вида документации. Например, doxygen никак не поможет пользователю GIMP узнать как создать альфа-канал и применить по нему фильтр.
Ответить | Правка | Наверх | Cообщить модератору

50. "Google представил инициативу по стимулированию написания док..."  +/
Сообщение от Аноним (48), 13-Мрт-19, 16:42 
> Ты путаешь тёплое с мягким. Doxygen — это техническая документация по API
> кода. Season of Docs же предназначен для пользовательской документации. Это два
> существенно различных вида документации. Например, doxygen никак не поможет пользователю
> GIMP узнать как создать альфа-канал и применить по нему фильтр.

Иначе говоря, в коде GIMP упомянутая операция никак не документирована.

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

52. "Google представил инициативу по стимулированию написания док..."  +/
Сообщение от bircoph (ok), 13-Мрт-19, 17:40 
>> Ты путаешь тёплое с мягким. Doxygen — это техническая документация по API
>> кода. Season of Docs же предназначен для пользовательской документации. Это два
>> существенно различных вида документации. Например, doxygen никак не поможет пользователю
>> GIMP узнать как создать альфа-канал и применить по нему фильтр.
> Иначе говоря, в коде GIMP упомянутая операция никак не документирована.

Пользователь (не разработчик!) по коду не сможет понять, как эту опцию использовать. Да и вряд ли её вообще там найдёт.

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

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

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

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

Архив | Удалить

Рекомендовать для помещения в FAQ | Индекс форумов | Темы | Пред. тема | След. тема




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

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