Intro to Computer Engineering

Style Guide


Getting the computer to understand your program is no guarantee that people will be able to follow it. Just as you would edit an English composition, you should spend time revising a computer program to make it elegant and readable. The following guidelines will help you write programs that are easy to read and modify.

Beginning with Assignment 1, the CSE 132 TAs will expect your assignments to conform to these style and documentation conventions. A large portion of your lab grade is based on style, so don't assume that it's good enough to just get your program running. Read this Style Guide carefully, and let us know if you have any questions.

The comment in the following example adds no information and should be omitted since it just wastes the reader's time:

int rectangleWidth = 5; //the rectangle has a width of 5

Generated at 2024-04-06 20:30:52 +0000.
Page written by Ron Cytron, Josh Gelbard, and Ben Stolovitz.