2012-01-12 19 views
15

Czy jest coś takiego jak JavaDocs dla JavaScript? Kiedy wciskam ctrl + spacja w netbeans IDE, podczas gdyDokumentacja JavaScript

pisząc javascript, dokument javascript wyjdzie dla określonego obiektu. Ale ta dokumentacja to chyba własność Netbeans.

Jeśli napiszemy javascript w odpowiedni komentarz, Netbeans buduje dokumenty dla naszego niestandardowego javascriptu.

Czy możemy znaleźć taką dokumentację javascript poza Netbeans? Abyśmy mogli się do tego odnieść?

Dzięki za odpowiedź.

Odpowiedz

11

Wystarczy popatrzeć na stronach doc na Mozilla Developer Network (MDN) dla statycznego odniesienia:

Jednak obawiam się, że nie ma Zakładka - zakończenie, które może być użyte wewnątrz IDE.

+0

Dokładnie to, czego potrzebowałem. – Acn

+9

Wskazówka wyszukiwania Google: dodaj "mdn" po wyrażeniu w języku javascript, np. "Substr mdn", a odpowiednia strona MDN prawie zawsze będzie pierwszym wynikiem wyszukiwania. – nnnnnn

+1

Nie chciałbym zrezygnować z ukończenia zakładki dla JsDoc (Javadocish) wewnątrz IDE. WebStorm mówi, że go obsługują: http://stackoverflow.com/questions/11076572/seeking-example-of-how-to-use-jsdoc-with-webstorm-ide-v-4 – SimplGy

8

W kodzie źródłowym swoich doodli na stronie głównej używają komentarzy, które bardzo przypominają komentarze javadoc, więc musi istnieć jakiś standard, którego używa przynajmniej Google.

Oto przykład:

/** 
* Configuration for a simulator speed setting. 
* - stepTime: ms between simulation steps that do something. 
* - emptyStepTime: ms between no-op steps. 
* - tapeTime: ms for a tape operation. 
* - branchTime: ms for a branch operation. 
* @typedef {{stepTime: number, tapeTime: number, emptyStepTime: number, 
*   branchTime: number}} 
* @private 
*/ 
+2

To są [JSDoc] (http://en.wikipedia.org/wiki/JSDoc) tagi, w tym przypadku dla kompilatora [Google Closure] (https://developers.google.com/closure/compiler/docs/js-for-compiler), więc mogą faktycznie służyć celowi funkcjonalnemu (myślę, że kompilator faktycznie je wymusza, na przykład znaczniki '@ typedef' i' @ private' w wklejanym przykładzie). – Ricket

0

Wypróbuj aplikację o nazwie Ortelius. Używa jakiejś składni podobnej do javadoc do generowania dokumentacji. ortelius.marten.dk