Document Your Development Code
0 likes470 views
This document discusses the importance of code documentation and introduces YARD as a documentation tool for Ruby. It recommends documenting code for maintainability and knowledge transfer. It also provides examples of using YARD tags and generating class diagrams from code documentation.
![http://jyaasa.com
class MyWebServer
# Handles a GET request
# @param request [Request] the request object
# @return [String] the resulting webpage
def get(request) "hello" end
# Handles a POST request
# @note This method may modify our application state!
# @param (see #get)
# @return (see #get)
def post(request) self.state += 1; "hello" end
end
A documented class
Copyright 2015. Jyaasa Technologies.](https://image.slidesharecdn.com/documentyourdevelopmentcode-jyaasatechnologies-151127062927-lva1-app6891/85/Document-Your-Development-Code-15-320.jpg)
Document Your Development Code
- 1. Document your Development Code Copyright 2015. Jyaasa Technologies. http://jyaasa.com
- 2. http://jyaasa.com Namaste ! I am Kapil Raj Nakhwa. I am a Ruby enthusiast working at Jyaasa Technologies ! Copyright 2015. Jyaasa Technologies.
- 4. “ http://jyaasa.com If it is not documented, It does not exist. As long as the information is stored in someone’s head, it is vulnerable to loss. Copyright 2015. Jyaasa Technologies.
- 5. http://jyaasa.com Traditional Software Development Says... oDocumentation helps Software Development oDocumentation helps maintain Software Quality oDocumentation makes it easy to Transfer Projects Copyright 2015. Jyaasa Technologies.
- 6. http://jyaasa.com Well, Screw it... oKnow Your code oLiterate your fellow programmers oRemove accidental redundancies oReduce overall development time oHand over the project Copyright 2015. Jyaasa Technologies.
- 7. “ http://jyaasa.com You either know how to program and code, and commenting is part of that, or you don’t. Either your team knows some or doesn’t Copyright 2015. Jyaasa Technologies.
- 8. http://jyaasa.com oGreat way to solidify Ruby fundamentals oMany prominent Rubyists and core contributors have started out this way Why You Should?
- 9. http://jyaasa.com ordoc oyard oTomdoc oSdoc oDocumentup orspec_api_doc oapipie-rails oAjax-rdoc Awesomeness in our Toolbox... Copyright 2015. Jyaasa Technologies.
- 10. http://jyaasa.com ogem install yard oyard doc oyard server oyard -help Picking easiest one Yard Copyright 2015. Jyaasa Technologies.
- 11. http://jyaasa.com oyard server –reload ohttp://www.rubydoc.info/ oTemplates : https://github.com/lsegal/yard/wiki/Templates oExtend: http://yardoc.org/guides/extending-yard/writing- handlers.html oAwesome Tools: oyard-blame https://github.com/lsegal/yard-blame oyard-stick https://github.com/dkubb/yardstick Why Yard? Copyright 2015. Jyaasa Technologies.
- 12. http://jyaasa.com Why Yard Meta Data Formatting Available Tags: http://www.rubydoc.info/gems/yard/file/docs/Tags.md#List_of_ Available_Tags Copyright 2015. Jyaasa Technologies.
- 13. http://jyaasa.com Compared to rdoc Copyright 2015. Jyaasa Technologies.
- 14. http://jyaasa.com In Yard Copyright 2015. Jyaasa Technologies.
- 15. http://jyaasa.com class MyWebServer # Handles a GET request # @param request [Request] the request object # @return [String] the resulting webpage def get(request) "hello" end # Handles a POST request # @note This method may modify our application state! # @param (see #get) # @return (see #get) def post(request) self.state += 1; "hello" end end A documented class Copyright 2015. Jyaasa Technologies.
- 16. http://jyaasa.com --query 'has_tag?(:api) && tag(:api).text == "public"' yard gems yard server --gems yard graph --protected --full --dependencies Use Cases Copyright 2015. Jyaasa Technologies.
- 17. http://jyaasa.com You like Class Diagrams? Have you ever generated one? Do you know what it is? Copyright 2015. Jyaasa Technologies.
- 18. http://jyaasa.comCopyright 2015. Jyaasa Technologies.
- 19. http://jyaasa.comCopyright 2015. Jyaasa Technologies.
- 20. http://jyaasa.com brew install graphviz gem install yard yard -n yard graph --dependencies | dot -Tpdf -o app_diagram.pdf I Used magick to generate those! Here’s the Spell: Copyright 2015. Jyaasa Technologies.
- 21. http://jyaasa.com Beside code docs. Educate yourself and your team Copyright 2015. Jyaasa Technologies.
- 22. http://jyaasa.com Beside code docs Copyright 2015. Jyaasa Technologies.
- 23. http://jyaasa.com Beside code docs Copyright 2015. Jyaasa Technologies.
- 24. http://jyaasa.com Beside code docs Copyright 2015. Jyaasa Technologies.
- 25. http://jyaasa.com Beside code docs Copyright 2015. Jyaasa Technologies.
- 26. http://jyaasa.com Final Words... Don’t be an asshole. Always document your code. Copyright 2015. Jyaasa Technologies.
- 28. http://jyaasa.com Thank You for listening! Questions? Find me on Twitter @xecutioner303 or hit me kapil@jyaasa.com Copyright 2015. Jyaasa Technologies.