The OpenNET Project / Index page

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



Индекс форумов
Составление сообщения

Исходное сообщение
"Изучение изменения размера кодовой базы Ext4, Btrfs и XFS"
Отправлено PereresusNeVlezaetBuggy, 23-Июн-11 21:33 
> http://wiki.lustre.org/lid/subsystem-map/subsystem-map.html
> вот документация которая генерится из исходников.
> Автоматически.
> Считаете это "на отвали" ?

Автоматически генерируемая документация полезна при использовании библиотек, так как при грамотной реализации позволяет быстро находить информацию о том или ином вызове. В собственном конечном проекте она, как правило, бесполезна, так как не добавляет никакой новой информации к редактироемому коду.

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

Касаемо примера выше — да, большая часть там, к сожалению, бесполезна.

 

Ваше сообщение
Имя*:
EMail:
Для отправки ответов на email укажите знак ! перед адресом, например, !user@host.ru (!! - не показывать email).
Более тонкая настройка отправки ответов производится в профиле зарегистрированного участника форума.
Заголовок*:
Сообщение*:
 
При общении не допускается: неуважительное отношение к собеседнику, хамство, унизительное обращение, ненормативная лексика, переход на личности, агрессивное поведение, обесценивание собеседника, провоцирование флейма голословными и заведомо ложными заявлениями. Не отвечайте на сообщения, явно нарушающие правила - удаляются не только сами нарушения, но и все ответы на них. Лог модерирования.



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

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