Warning: Cannot use a scalar value as an array in /home/admin/public_html/forum/include/fm.class.php on line 757

Warning: Invalid argument supplied for foreach() in /home/admin/public_html/forum/include/fm.class.php on line 770
Форумы портала PHP.SU :: Версия для печати :: Контроль версий
Форумы портала PHP.SU » Клиентская разработка » Программное обеспечение » Контроль версий

Страниц (1): [1]
 

1. RoboStudent - 24 Ноября, 2010 - 07:43:43 - перейти к сообщению
Здравствуйте!

Начну с примера:
Комментарий из какого-то файла системы WordPress.

PHP:
скопировать код в буфер обмена
  1. /**
  2.  * Writes logging info to a file.
  3.  *
  4.  * @since 2.2.0
  5.  * @uses $app_logging
  6.  * @package WordPress
  7.  * @subpackage Logging
  8.  *
  9.  * @param string $label Type of logging
  10.  * @param string $msg Information describing logging reason.
  11.  */

Далее следует функция, описанная в данном комментарии (остальные функции WP
тоже имеют такие аннотации, при чем такое же и именно в таком же виде я встречал
в еще нескольких CMS, то есть тут "ручками" - отпадает. Это какой-то софт у них =)).

То, что описание функции пишется ручками - это понятно, но что проставляет
типы переменных и версию, начиная с которой эта функция существует?
Не верю что тоже ручками =)

Заранее премного благодарен даже за малейшую наводку!
2. RoboStudent - 24 Ноября, 2010 - 12:53:21 - перейти к сообщению
Сам же ответил на свой вопрос - "Eclipse for PHP Developers" ну и тот же Zend Studio (те же айцы, только в профиль).
Ставим курсор на функцию, над которой необходимо создать описание с перечислением переменных,
в меню жмем "Source" -> "Generate Element Comment" и вуаля.
Кстати Eclipse неплохой стал, судя по всему. Года полтора назад он меня чем-то оттолкнул и я не стал даже углубляться,
а сейчас покопался и очень даже неплохо на первый взгляд. Не хуже NotePad++ в плане написания кода.
3. movEAX - 25 Ноября, 2010 - 08:29:52 - перейти к сообщению
RoboStudent пишет:
"Eclipse for PHP Developers"

В NetBeans так же есть такая возможность, в PHPStorm наверное тоже имеется.
4. RoboStudent - 25 Ноября, 2010 - 11:54:39 - перейти к сообщению
После исследования Ecplise, могу сказать только одного - для меня это тормозная и неуклюжая IDE. На любителя.
Редактировать-то хорошо, а вот всё что вокруг редактора - оставляет желать лучше. Особенно "порадовало", что
пару раз при запуске слетали настройки палитр, да и вообще практически все настройки Eclipse =)
Конечно, если за ней поработать месяца три, то наверное слюбится-стерпится, но мне это не нужно.

movEAX пишет:
В NetBeans так же есть такая возможность

Пожалуйста, скажи - как это реализовано в NetBeans? Я второй час его бью, не могу найти. Комментарии, шаблоны,
лицензии, но аннотации к функциям - днём с огнем не найти. Или я сыСЧик такой =)
А PHPStorm видимо очень "хороший", что про него даже на вики нет ни слова =)
5. RoboStudent - 25 Ноября, 2010 - 17:29:59 - перейти к сообщению
Вопрос из первого топика полностью исчерпан. Надеюсь что я не зря потратил время на выяснение и
кому-то помимо меня это пригодится.

По порядку:
1) Небольшая, но полезная статья на русском языке касательно комментирования кода - http://serg-hd[dot]com/?p=314
Здесь автор говорит о PHPDoc, но рассмотрите и другие генераторы документаций.
2) phpDocumetor и перечень возможных параметров для него - тут (в глоссарии нажмите "Tags")
3) Doxygen - тоже отличный генератор, еще и выдача на русском языке.

Я пока что ни на одном не остановился. Знакомлюсь.

Подобного рода аннотации ловко вставляет Eclipse (и Zend, понятное дело).
NetBeans хороший, но я так и не нашел как в нем это делается =) В нем есть шаблоны,
но это получается "вставил" и ручками всё правь под функцию, а Eclipse сразу всё подставляет,
кроме типа параметров и комментария.

В общем, кому интересно - разберетесь. Надеюсь кому-то пригодится.
6. movEAX - 25 Ноября, 2010 - 18:31:14 - перейти к сообщению
RoboStudent пишет:
Пожалуйста, скажи - как это реализовано в NetBeans? Я второй час его бью, не могу найти. Комментарии, шаблоны,
лицензии, но аннотации к функциям - днём с огнем не найти. Или я сыСЧик такой =)

Возле объявления функции открываешь многострочный комментарий /** и все)
RoboStudent пишет:
А PHPStorm видимо очень "хороший", что про него даже на вики нет ни слова =)

Хорошая шутка) http://www[dot]jetbrains[dot]com/
7. ALEN - 25 Ноября, 2010 - 20:59:47 - перейти к сообщению
Немного от темы отойду...
Все это кончено прикольно, оставлять свои автографы на страницах, но скажу так - бывает открываешь исходник, а там такой хлам, а вот автограф стоит.
Первым делом нужно содержимое отточить, а потом хвастаться, а выходит, что основные силы уходят на такой хлам.
8. movEAX - 25 Ноября, 2010 - 21:04:29 - перейти к сообщению
ALEN пишет:
что основные силы уходят на такой хлам.

Комментарии к коду и самодокументирование - хлам?) Что-то сегодня много шутят..
9. ALEN - 25 Ноября, 2010 - 21:07:38 - перейти к сообщению
movEAX
Я не против, но когда действительно код хороший!
10. RoboStudent - 26 Ноября, 2010 - 00:29:19 - перейти к сообщению
movEAX пишет:
Хорошая шутка) http://www.jetbrains.com/

Спасибо за ссылку! Оказывается оно еще и платное. Исключено.

movEAX пишет:
Возле объявления функции открываешь многострочный комментарий /** и все)

Ставил по привычке /*, он из этого делает обычный коммент-блок, а вот /** ... Спасибо! =)

ALEN пишет:
Я не против, но когда действительно код хороший!

Ну то само собой!

 

Powered by ExBB FM 1.0 RC1