Здравствуйте. У меня есть десяток свеженаписанных библиотек, которые, во-первых, широко используются внутри моего проекта, а во-вторых, планируются к выкладыванию на гитхаб. Тесты написаны, библиотеки работают, всё отлично, кроме того, что они не документированы совсем никак. И мне нужен генератор документации для яваскрипта. Не то, что делает, например, JSDoc, а именно генерация каркаса документации в самом js-файле.
Например, на php я писал обёртку над php_beautifier, которая генерит пустой PHP-doc и ставит @TODO, если не смогла разобраться с типами, например.
Быть может, какая-то IDE умеет это делать? Спасибо.
я имею в виду что-то вроде автогенерации PHPDoc для php же в, например, phpStorm.
Там я ставлю курсор на название метода в его описании, жму Cmd+N и оно генерит мне каркас типа того:
<?php
/**
* Created by JetBrains PhpStorm.
* User: test
* Date: 04.04.12
* Time: 14:09
* To change this template use File | Settings | File Templates.
*/
class Foo {
/**
* @var Bar|null
*/
private $bar;
/**
* @param Bar|null $bar
*/
public function __construct(Bar $bar = null) {
$this->bar = $bar;
}
/**
* @return Bar|null
*/
public function getBar() {
return $this->bar;
}
}
