[ Поиск ] - [ Пользователи ] - [ Календарь ]
Полная Версия: Документирование и комментирование
ruzarh
Не могли бы вы рассказать как грамотнее вести документацию и комментирование к проекту! Чтобы избежать подводных камней и лишних телодвижений!


И еще вопрос стоит ли удалять комментарии при выводе проекта в работу(Это сэкономит ресурсы сервера или это не к чему?)



Спустя 1 час, 29 минут, 34 секунды (9.09.2010 - 10:06) Nikitian написал(а):
Никогда не удаляйте комментарии, пока они актуальны!
Комментирую в стиле phpDoc, что довольно удобно для понимания как человеком, так и парсером netbeans.

Спустя 1 час, 35 минут, 4 секунды (9.09.2010 - 11:41) twin написал(а):
Если комментировать код без фанатизма, только по делу, ничему это не помешает. Ну займет он в проекте несколько килобайт, зато сколько пользы от него. И себе, и тому, кто потом будет со скриптом работать.

Не стоит вообще удалять.

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

Спустя 6 минут, 3 секунды (9.09.2010 - 11:47) amazing написал(а):
Желательно четкие, осмысленные коментарии, без лишней воды... А то встречались такие, что писатели позавидуют.

Спустя 3 часа, 39 минут, 9 секунд (9.09.2010 - 15:26) ruzarh написал(а):
Т.е. только размер, о скорости обработки скрипта речь не идет! То и переживать нечего! А насчет документирования может есть что нибудь что бы делать не одному и мне было видно что нового в проекте и что где находится!

Спустя 9 минут, 25 секунд (9.09.2010 - 15:36) twin написал(а):
Ну переживать есть чего))) Правда гипотетически. Всетаки файл грузится в оперативку и его размер имеет значение при экономии ресурса.

Спустя 3 минуты, 28 секунд (9.09.2010 - 15:39) Nikitian написал(а):
Цитата (twin @ 9.09.2010 - 12:36)
Ну переживать есть чего))) Правда гипотетически. Всетаки файл грузится в оперативку и его размер имеет значение при экономии ресурса.

Ну как бэ пхп - интерпретируемый язык и при трансляции комменты вырезаются. Опять же если всяческие xCache и прочие асселераторы, которые как раз кэшируют уже транслированный код.

Спустя 13 минут, 37 секунд (9.09.2010 - 15:53) twin написал(а):
Ну я тонкостей не знаю... хотя по логике, чтобы вырезать все равно загрузить надо.


_____________
Не портите мои нервные клетки, так как в них живут нервные тигры!
Быстрый ответ:

 Графические смайлики |  Показывать подпись
Здесь расположена полная версия этой страницы.
Invision Power Board © 2001-2025 Invision Power Services, Inc.