Good Programming Practices

Good Programming Practices - Good Programming Practices Dr...

Info icon This preview shows pages 1–6. Sign up to view the full content.

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

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

View Full Document Right 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.
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(); * // ****************************************** // ******************************************
Image of page 3

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

View Full Document Right Arrow Icon
Header Files Only include header files that are necessary to avoid cluttering your program. Use header files to include public interfaces through .h files. Use the #ifdef and #endif to avoid redundant includes.
Image of page 4
Example #ifndef #ifndef MYOWNHEADER #include <myfunctions.h> #include <hisfunctions.h> #endif // What this does if the group of functions // myfunction.h and hisfunctions.h have not been // defined in this way then it is included in // the program other wise this step is skipped.
Image of page 5

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

View Full Document Right Arrow Icon
Image of page 6
This is the end of the preview. Sign up to access the rest of the document.

{[ snackBarMessage ]}

What students are saying

  • Left Quote Icon

    As a current student on this bumpy collegiate pathway, I stumbled upon Course Hero, where I can find study resources for nearly all my courses, get online help from tutors 24/7, and even share my old projects, papers, and lecture notes with other students.

    Student Picture

    Kiran Temple University Fox School of Business ‘17, Course Hero Intern

  • Left Quote Icon

    I cannot even describe how much Course Hero helped me this summer. It’s truly become something I can always rely on and help me. In the end, I was not only able to survive summer classes, but I was able to thrive thanks to Course Hero.

    Student Picture

    Dana University of Pennsylvania ‘17, Course Hero Intern

  • Left Quote Icon

    The ability to access any university’s resources through Course Hero proved invaluable in my case. I was behind on Tulane coursework and actually used UCLA’s materials to help me move forward and get everything together on time.

    Student Picture

    Jill Tulane University ‘16, Course Hero Intern