Missing Features

A programmer who uses the wrong print format when circulating code for review is like Jar Jar Binks in Star Wars: just plain annoying. The right format is pretty simple, yet your correspondent frequently encounters programmers who don’t prepare the code in the right way.

Here are the dead-simple requirements for preparing code for circulation:

1. Make it a PDF
2. Make the page orientation landscape*
3. Include line numbers!
4. Make sure the code is color-highlighted
5. Include the filename at the top of each page
6. Include page numbers at the bottom of each page
7. The file name of the PDF should be the filename of the code

If you are a programmer and you don’t follow these guidelines then all you are doing is putting your reviewer in a foul mood. Not the best way to start a review.

* After all, code tends to be wider than it is longer

Trackback URI | Comments RSS