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

Warning: Invalid argument supplied for foreach() in /home/admin/public_html/forum/topic.php on line 737
Форумы портала PHP.SU :: Генерирование доки по JavaScript

 PHP.SU

Программирование на PHP, MySQL и другие веб-технологии
PHP.SU Портал     На главную страницу форума Главная     Помощь Помощь     Поиск Поиск     Поиск Яндекс Поиск Яндекс     Вакансии  Пользователи Пользователи


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

> Без описания
biperch
Отправлено: 10 Апреля, 2013 - 14:51:51
Post Id



Частый посетитель


Покинул форум
Сообщений всего: 588
Дата рег-ции: Окт. 2009  
Откуда: Днепропетровск


Помог: 8 раз(а)




Есть такая классная прога называется ApiGen генерит доку по коментам в пхп коде.
PHP:
скопировать код в буфер обмена
  1. /**
  2. *  Модуль интерфейсов партнёра и администрирования партнёров.
  3. *
  4. * @package    em-partners
  5. * @author     Aether Development Inc. <relation@aetherdevelopment.com>
  6. * @link       http://www.aetherDevelopment.com
  7. */
  8.  
  9. /**
  10.  * Load a service object from the database.
  11.  *
  12.  * @param $param
  13.  *   Either the nid of the node or an array of conditions to match against in the database query
  14.  * @param $reset
  15.  *   Whether to reset the internal service_load cache.
  16.  *
  17.  * @return
  18.  *   A fully-populated service object.
  19.  */


Меня интересует есть ли что то для того что бы генерить доку по JS и вообще есть ли какой то четкий стандарт по документированию JS
 
 Top
Zuldek
Отправлено: 10 Апреля, 2013 - 14:55:43
Post Id


Постоянный участник


Покинул форум
Сообщений всего: 2122
Дата рег-ции: Июнь 2010  


Помог: 50 раз(а)




http://ru[dot]wikipedia[dot]org/wiki/JSDoc
Ну прог именно для генерирования документации не использовал: IDE-среды все это умеют и кажут сами, что по php, что по иному коду. С Js честно говоря не сталкивался с такой уж явной необходимостью документирования: стараются наоборот как можно сильнее все ужать в библиотеке. Больше ценное в процессе разработки. По завершению коменты обычно сам удаляю.

(Отредактировано автором: 10 Апреля, 2013 - 15:06:22)

 
 Top
biperch
Отправлено: 10 Апреля, 2013 - 14:56:52
Post Id



Частый посетитель


Покинул форум
Сообщений всего: 588
Дата рег-ции: Окт. 2009  
Откуда: Днепропетровск


Помог: 8 раз(а)




вот вид доки по пхп
(Добавление)
по ТЗ нужно документировать код это рас, а два просят доку по функциям отдельно предоставить

работаю в Netbens, apigen тут генерит по рhр доку, а так как в проект типа по пхп то он только по пхп и генерит, а по js отдельно надо получается
ниже скрин как jsDoc генерит доку, не шибко симпотично, хотя я еще со всеми его тегами не разобрался и со стилем документирования

Нажмите для увеличения

Прикреплено изображение (Нажмите для увеличения)
Снимок экрана - 10.04.2013 - 14:56:24.png
 
 Top
Страниц (1): [1]
Сейчас эту тему просматривают: 0 (гостей: 0, зарегистрированных: 0)
« JavaScript & VBScript »


Все гости форума могут просматривать этот раздел.
Только зарегистрированные пользователи могут создавать новые темы в этом разделе.
Только зарегистрированные пользователи могут отвечать на сообщения в этом разделе.
 



Powered by PHP  Powered By MySQL  Powered by Nginx  Valid CSS  RSS

 
Powered by ExBB FM 1.0 RC1. InvisionExBB