Dokumentáljunk, de hogyan?

400 views

Published on

Budapest.js 2012.05.14.

0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total views
400
On SlideShare
0
From Embeds
0
Number of Embeds
1
Actions
Shares
0
Downloads
0
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

Dokumentáljunk, de hogyan?

  1. 1. HTTP://WWW.VIRTUAL-CALL-CENTER.EU/ Dokumentáljunk! De hogyan? Farkas Máté Budapest.js, 2012.05.14.
  2. 2. Tematika- Alapelvek- JsDoc toolkit- docco- NaturalDocs
  3. 3. http://geekandpoke.typepad.com/geekandpoke/2012/04/the-new-developer.html Miért is? Miért készítsünk forrás szintű dokumentációt?
  4. 4. Mindennek az alapja A legfontosabb, hogy a kód „öndokumentált” legyen.http://perro.si/spaghetti-code
  5. 5. Mindennek az alapja/** * A difficult, but * frequently used function. * * @param a the first parameter * @param q the second parameter * @returns the result */myClass.doIt = function(a, q) { /* ... */ return result;}
  6. 6. Mindennek az alapja<?phpclass TestResource extends Resource { /** * A GET kérés kezelése. * @param Request kérés * @return Response */ function post($request) { //...
  7. 7. JsDoc toolkit“JsDoc Toolkit is an application for automatically generating documentation from commented JavaScript source code.” (Michael Mathews)
  8. 8. JsDoc toolkitSyntax myFunction MyConstructor MyConstructor#instanceMember MyConstructor.staticMember MyConstructor-innerMember
  9. 9. JsDoc toolkit“As of 27 June 2010 the JsDoc Toolkit Version 2 project is no longer accepting any new Feature Request tickets. Any Feature Request tickets submitted after that date will be deleted without comment.”Használják ma is: Google’s ClosureLinter, InteliJ IDEA, Eclipse, SproutCore…
  10. 10. docco“Docco is a quick-and- dirty, hundred-line- long, literate-programming- style documentation generator.”Azt mutatja, hogyan működik, nem azt, hogy
  11. 11. NaturalDocs“Natural Docs is an open-source documentation generator for multiple programming languages.You document your code in a natural syntax that reads like plain English.”
  12. 12. NaturalDocsFunction: MultiplyMultiplies two integers.Parameters: x - The first integer. y - The second integer.Returns: The two integers multiplied together.See Also: <Divide>
  13. 13. HTTP://WWW.VIRTUAL-CALL-CENTER.EU/ Kérdések? Farkas Máté Budapest.js, 2012.05.14.
  14. 14. LinkekDokumentációs eszközök:http://code.google.com/p/jsdoc-toolkit/http://jashkenas.github.com/docco/http://www.naturaldocs.org/Az előadóról:http://www.virtual-call-center.hu/http://farkas-mate.hu/

×