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 :: Версия для печати :: Генерирование доки по JavaScript
Форумы портала PHP.SU » Клиентская разработка » JavaScript & VBScript » Генерирование доки по JavaScript

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

1. biperch - 10 Апреля, 2013 - 14:51:51 - перейти к сообщению
Есть такая классная прога называется 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
2. Zuldek - 10 Апреля, 2013 - 14:55:43 - перейти к сообщению
http://ru[dot]wikipedia[dot]org/wiki/JSDoc
Ну прог именно для генерирования документации не использовал: IDE-среды все это умеют и кажут сами, что по php, что по иному коду. С Js честно говоря не сталкивался с такой уж явной необходимостью документирования: стараются наоборот как можно сильнее все ужать в библиотеке. Больше ценное в процессе разработки. По завершению коменты обычно сам удаляю.
3. biperch - 10 Апреля, 2013 - 14:56:52 - перейти к сообщению
вот вид доки по пхп
(Добавление)
по ТЗ нужно документировать код это рас, а два просят доку по функциям отдельно предоставить

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

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

 

Powered by ExBB FM 1.0 RC1