Good Programming Practices

Good Programming Practices - Good Programming Practices Dr...

Info iconThis preview shows pages 1–5. Sign up to view the full content.

View Full Document Right Arrow Icon
Good Programming Practices Dr. David A. Gaitros
Background image of page 1

Info iconThis preview has intentionally blurred sections. Sign up to view the full version.

View Full DocumentRight Arrow Icon
Comments Comments should give information to programmers that would not be obvious by reading the code. Should keep comments and code separate Should discuss parameters, formulas, external call, and include a sample call to the function.
Background image of page 2
Example // ****************************************** // ****************************************** // * * // * Function Name: Myfunction * // * Author: Dr. David A. Gaitros * // * Date: April 4, 2011 * // * Function Parameters: None * // * Description: This is where you place * // * Comments about how your code works * // * and any features that would not be * // * obvious by an experienced programmer. * // * Sample Call: * // * X = Myfunction(); * // ****************************************** // ******************************************
Background image of page 3

Info iconThis preview has intentionally blurred sections. Sign up to view the full version.

View Full DocumentRight Arrow Icon
Only include header files that are necessary to avoid cluttering your program. Use header files to include public
Background image of page 4
Image of page 5
This is the end of the preview. Sign up to access the rest of the document.

This note was uploaded on 11/07/2011 for the course COP 3014 taught by Professor Tyson during the Fall '10 term at FSU.

Page1 / 11

Good Programming Practices - Good Programming Practices Dr...

This preview shows document pages 1 - 5. Sign up to view the full document.

View Full Document Right Arrow Icon
Ask a homework question - tutors are online