Меню
Что нового?

Документирование кода c поддержкой php5

  • Автор темы Автор темы korpus
  • Дата начала Дата начала
korpus

korpus

злой бобёр
Документирование кода c поддержкой php5

Меня интересует удобное приложение для документирование кода. Рассмотрел phpDocumentor, а потом узнал, что есть ещё другие приложения для документирования кода. Посоветуйте что следует использовать в первую очередь? Мне бы хотелось, чтобы код документировался с учётом ООП в php5. В phpDocumentor к сожалению с этим плохо. Кроме того в генерируемых html страницах есть какая-то ошибка, связанная со Smarty. Может есть что-то более стоящее?
Но хотелось бы, чтобы у приложения был удобный вебинтерфейс, как у phpDocumentor.
 
phpDocumentor является реализацией концепции xDoс, которая, на мой взгляд, является наиболее растространенной в настоящее время. почему плохо с документированием ООП - совершенно не понятно, мы в своей практике, вполне удачно используем этот формат. альтернативы конечно есть, например - Doxygen. однако большинство IDE поддерживают xDoc, поэтому преимущество этого формата является неоспоримым.

зы. единственная проблема у phpDocumentor'а, с которой сталкивался - приходится править шаблоны (кодировку) для нормального использования русского языка.
 
grigori +1

Но это понимаешь.. когда хотя бы раз придется поработать, например, с кодом с финскими комментами и названиями переменных :)
 
Автор оригинала: Long
зы. единственная проблема у phpDocumentor'а, с которой сталкивался - приходится править шаблоны (кодировку) для нормального использования русского языка.
Нажмите для раскрытия...
А ещё менять расширения css файлов с .cs на .css
 
grigori, можно конечно поофтопить на тему на каком языке писать комментарии в коде :) но если:
1. код пишется для российского проекта
2. далеко не всегда можно добится внятного комментария на родном языке
обязывать комментировать на английском - крайне не разумно.
 
it depends, как обычно
когда пишешь для себя - nobody cares
если подразумевается, что с кодом будут работать другие - только английский

если разработчик не знает ломаный английский и не умеет комментировать даже на родном, может, стоит задуматься о качестве кода, который он пишет, и реальной цене этого "дешевого" кода с учетом цены поддержки?
 
мы как-то работали с израильтянами, они присылали задание на свойм "английском", мы его читали на своём "английском". бред был полнейший. с тех пор я практически всегда стараюсь писать на русском, а не заморачиваться с английским, пускай там воспользуются гулопереводчиком, чем дважды искажать смысл.
 
если подразумевается, что с кодом будут работать другие - только английский
Нажмите для раскрытия...
Не надо свои аутсорс-фрилансовые представления переносить на всех :)

Комментарии по английски надо писать только тогда, когда это имеет смысл.
 
Если код пишеш не для себя думаю всегда имеет смысл писать комментарии на английском
 
AmdY
ну дык, избранный народ же ...
помню историю, как исраИльские чудаки купили компанию в Штатах и вели идиш корпоративным языком,
так сотрудники их засудили за дискриминацию :)

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

твой случай подтверждает правило: не знаешь английского - пили гантели, пиши только для своей конторы
а те твои заказчики теряют больше, ведь они теряют время, силы и деньги на переделку неправильно понимаемого задания


Krishna
визуализатор профайлера ты в рашке собирался продавать? ;)

-~{}~ 31.05.10 03:13:

korpus
та некогда! в интернете кто-то неправ!
 
Войдите или зарегистрируйтесь для ответа.
Сверху