Self Documenting Code - Rachel Slaybaugh

Attending

• Prof. Rachel Slaybaugh
• Ryan Bergmann
• Jankai (Jack) Yu
• Dan Wooten
• Sandra Bogetic
• Christian DiSanzo
• Josh Howland
• Alex Chong
• Kelly Rowland
• Phil Gorman
• Jason Hou

Lesson: Code Documentation

Rachel gave a brief overview of a variety of documentation strategies, including how to write code comments that generate a useful API. Here is [Rachel’s Tutorial][rachelstalk].

Lightning Talks

[rachelstalk]: https://github.com/thehackerwithin/berkeley/tree/master/documentation/documentation.md “Rachel’s Tutorial”

title: Documentation - Rachel Slaybaugh comments: true category: posts tags: meeting documentation —

Lesson: Introduction to Documentation

Professor Rachel Slaybauh gave an introduction to documenting code. This covered:

• Code Comments
• API Documentation
• Auto-Documentation
• Self-Documenting Code
• Readmes
• User Guides
• Developer Guides

You can find details about this topic from the meeting notes.