Star Fork
  • LeanPub eBook
  • About
  • GitHub
  • Blog

Document your code

Posted on January 1, 1970

Code documentation is more than just writing human-readable code comments. It is also about creating functional comments in specific formats (like RDoc or YARDOC) that are clear to other developers, and that can be interpreted by your IDE.

  • Rails API doc Guideline
  • RDoc
  • YARDOC

Remember that this documentation can help your IDE to make correct autocompletions of returned values, and object attributes/methods.

  • RubyMine: Creating Documentation Comments
  • RubyMine: Using Annotations
  • ← Previous Post
  • Next Post →

Ievgen Kuzminov  •  2018  •  RWDTOW.StdOut.in

Licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License

Theme by beautiful-jekyll