Java Style Guides

"Programs must be written for people to read, and only incidentally for machines to execute." -- Abelson & Sussman, "Structure and Interpretation of Computer Programs"

Writing code is an important aspect of this course. As part of that it is important to note that your code not only "works", but is also readable by humans. As such, you should take care in authoring code that is easy to read, clear, concise, and gives the reader (both the future you and the course staff) a solid understanding of what your code is doing. Please review the following links that will help direct you towards writing code that can be easily read.

• Java Coding Style Guide
• Java Programming Style Guide
• How to Document Source Code Responsibly
• Code Tells You How, Comments Tell You Why
• Putting Comments in Code: The Good, The Bad, And The Ugly