The OpenNET Project / Index page

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



"Рабочий стол Budgie переходит с GTK на библиотеки EFL от проекта Enlightenment"
Версия для распечатки Пред. тема | След. тема
Форум Разговоры, обсуждение новостей
Исходное сообщение [ Отслеживать ]
Заметили полезную информацию ? Пожалуйста добавьте в FAQ на WIKI.
. "Рабочий стол Budgie переходит с GTK на библиотеки EFL от про..." +/
Сообщение от ммнюмнюмус (?), 18-Сен-21, 02:09 
Что значит тру - как в suckless что-ли?
Конечно, подход к документированию как в doxygen и gtk-doc сильно неудобный, т.к. там документация как правило дублирует имеющуюся инфу.
Например, описание функции польностью повторяет объявление функции. А в описании структуры - вся структура.
Ещё это железъное правило - коммент перед кодом. Верно, но только иногда.

Комент может быть первым только если выполняет роль заголовка (для секции относительно громоздкого кода). Если же это описание для документации, то оно идёт после (либо в конце, либо на следующей в строке), лучший пример - man страницы из руководств Linux, POSIX и libc. Такой исходник должен быть поприятнее для чтения, при том, что сгенерировать удобные pdf и html всё также не проблема. Просто генератор должен извлекать информацию из самого исходника. Кстати, создавать pdf и html непрямую вообще не нужно. Хватит поддержки markdown, asciidoc или retext - из них потом (если очень хочется) можно что угодно сгенерировать.

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

Оглавление
Рабочий стол Budgie переходит с GTK на библиотеки EFL от проекта Enlightenment, opennews, 15-Сен-21, 12:00  [смотреть все]
Форумы | Темы | Пред. тема | След. тема



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

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