https://mirkwood.cs.edinboro.edu/dokuwiki/ 2026-04-30T16:30:39+00:00 https://mirkwood.cs.edinboro.edu/dokuwiki/ https://mirkwood.cs.edinboro.edu/dokuwiki/lib/tpl/dokuwiki/images/favicon.ico text/html 2022-08-02T11:59:13+00:00 Anonymous (anonymous@undisclosed.example.com) https://mirkwood.cs.edinboro.edu/dokuwiki/doku.php?id=guides:programstyle:codeblocks&rev=1659441553&do=diff Compound Statements or Code Blocks Short Answer The body of all control structures should be enclosed in a code block. This rule applies to control structure bodies with a single simple statement. Acceptable examples: if (x > 5) { big = true; } for (i = 0; i < 10; i++) { cout << i << endl; } do { ProcessItem(count); } while ( count < 7); text/html 2022-08-02T11:59:13+00:00 Anonymous (anonymous@undisclosed.example.com) https://mirkwood.cs.edinboro.edu/dokuwiki/doku.php?id=guides:programstyle:comments&rev=1659441553&do=diff Comments and Documentation This guide provides general guidelines for the use of comments and documentation. Directions given by your instructor supersede these instructions. The purpose of comments and documentation is to allow readers of the program to understand what is happening. This could be the original programmer, someone who has taken over maintenance of the code, or even a casual reader of the code. Documentation generally falls into two categories, comments and self documenting c… text/html 2022-08-02T11:59:13+00:00 Anonymous (anonymous@undisclosed.example.com) https://mirkwood.cs.edinboro.edu/dokuwiki/doku.php?id=guides:programstyle:constants&rev=1659441553&do=diff Constants If a constant used in a program has a meaning, or it is possible that this constant may be changed in the future, the constant should be named. In general there should be no magic numbers or numbers that have a meaning but are not named, in a program. text/html 2022-08-02T11:59:13+00:00 Anonymous (anonymous@undisclosed.example.com) https://mirkwood.cs.edinboro.edu/dokuwiki/doku.php?id=guides:programstyle:functions&rev=1659441553&do=diff Functions The proper use of functions can create code which is readable, can be debugged, and can be extended. Functions can break code into small, more understandable segments. Functions can be used to eliminate duplicated code. The local style guide suggests students err on the side of creating too many functions. text/html 2022-08-02T12:07:46+00:00 Anonymous (anonymous@undisclosed.example.com) https://mirkwood.cs.edinboro.edu/dokuwiki/doku.php?id=guides:programstyle:globals&rev=1659442066&do=diff Global Variables Global variables are variables that are declared outside the scope of a function. While it is common, even encouraged, to declare global constants, global variables are problematic as program size increases. Because of this, the use of global variables should be limited. text/html 2022-08-02T11:59:13+00:00 Anonymous (anonymous@undisclosed.example.com) https://mirkwood.cs.edinboro.edu/dokuwiki/doku.php?id=guides:programstyle:goto&rev=1659441553&do=diff Use of goto/break/continue/return Statements All of these statements change the flow of control in a c++ program. They change the behavior of control structures and therefore make it more difficult to understand the final flow of control in a program. For these reasons, the use of these statements is heavily restricted. text/html 2022-08-02T11:59:13+00:00 Anonymous (anonymous@undisclosed.example.com) https://mirkwood.cs.edinboro.edu/dokuwiki/doku.php?id=guides:programstyle:identifiers&rev=1659441553&do=diff Conventions for Identifiers In a programming language, and identifier is a name associated with a user declared item in the program. This may include variables, constants, types, functions, or other items. There are two basic conventions that simplify program comprehension when creating identifiers. Identifiers name should be meaningful and should follow the formatting convention. text/html 2022-08-02T11:59:13+00:00 Anonymous (anonymous@undisclosed.example.com) https://mirkwood.cs.edinboro.edu/dokuwiki/doku.php?id=guides:programstyle:indentation&rev=1659441553&do=diff Indentation The goal of indentation is to make it easier for programmers to recognize blocks of code contained within a structure. To that end, code within a structure should be indented by a standard amount. A second use of indentation is to associate code from a single statement which exceeds a single line with the beginning of that statement. text/html 2022-08-02T11:59:13+00:00 Anonymous (anonymous@undisclosed.example.com) https://mirkwood.cs.edinboro.edu/dokuwiki/doku.php?id=guides:programstyle:start&rev=1659441553&do=diff Local Programming Style Guide C++ * Identifiers * Use of Constants * Comments and Documentation * Use of Whitespace * Code Blocks * Indentation * Use of goto/continue/break/return Statements * Functions * Global Variables * The Standard Algorithm/Template Libraries * Other Items text/html 2022-08-02T11:59:13+00:00 Anonymous (anonymous@undisclosed.example.com) https://mirkwood.cs.edinboro.edu/dokuwiki/doku.php?id=guides:programstyle:whitespace&rev=1659441553&do=diff Use of Whitespace in Programs Whitespace is a character or set of characters that produce “space” in a text file. Generally whitespace is generated by three keys, the spacebar, the tab key, and the enter key. The appropriate use of whitespace characters greatly enhances the readability of code.