{"id":134,"date":"2016-07-29T17:10:12","date_gmt":"2016-07-29T17:10:12","guid":{"rendered":"https:\/\/courses.ideate.cmu.edu\/15-104\/f2022\/?page_id=134"},"modified":"2020-09-04T10:23:57","modified_gmt":"2020-09-04T14:23:57","slug":"dos-and-donts-of-style","status":"publish","type":"page","link":"https:\/\/courses.ideate.cmu.edu\/15-104\/f2022\/dos-and-donts-of-style\/","title":{"rendered":"Do’s and Don’ts of Style"},"content":{"rendered":"\n

A great programmer makes their code clear<\/strong>, robust<\/strong>, efficient<\/strong>, and user-friendly<\/strong>.
\nCode needs to be clear so others can read and understand your code.
\nCode needs to be robust<\/a>* to reduce the number of errors in your program.
\nCode needs to be efficient to reduce the cost of your code.
\nCode needs to be user-friendly so that people will want to use your program.<\/p>\n

Here are some Do’s and Don’ts that will guide you to becoming a better programmer. Bad style will cost your grade<\/strong> so keep these in mind and think of your own as well.<\/p>\n

Comment your code concisely<\/li>\n
Give your variables and functions good names for clarity<\/li>\n
End your phrases with semi-colons<\/li>\n
Indent your code properly<\/li>\n
Include your name, andrew ID, and section on the top of your code<\/li>\n<\/ul>
DON’T:
<\/strong><\/p>\n
Have more than 80 characters in a line.<\/li>\n
Have dead code (code that does nothing, or commented out code)<\/li>\n
Use meaningless variable names<\/li>\n
Use magic numbers (numbers that come out of nowhere)<\/li>\n
Add too many comments, or redundant comments.<\/li>\n
Use tab characters – fix your editor to insert spaces instead of tabs<\/a>.<\/li>\n<\/ul>
Here is a comparison of good and terrible code. If you can’t differentiate the two, ask for assistance as soon as possible.<\/p>\n
\/*\n * Andrew Carnegie\n * andrew@andrew.cmu.edu\n * Section Z\n *\n * This program draws gray concentric circles.\n *\/\n\nfunction setup() {\n createCanvas(600, 600); \/\/ Sets up the canvas size\n background(50); \/\/ background is dark gray\n}\n\nfunction draw() {\n \/\/ draw a 4-ringed circle in the center of the screen\n drawConcentric(width \/ 2, height \/ 2, width \/ 3, 4);\n}\n\nfunction drawConcentric(xLoc, yLoc, radius, numRings) {\n \/\/ Interate through numRings and draw circles of decreasing\n \/\/ size.\n for (i = 1; i <= numRings; i++) {\n ellipse(xLoc, yLoc, radius \/ i, radius \/ i);\n }\n}<\/pre>\n
\/\/ Lol comments\n\nfunction setup()\n{\n createCanvas(600, 600);\n background(50);\n background(2);\n background(7);\n}\n\nfunction draw() {\n \/\/ draw a 4-ringed circle in the center of the screen\n Draw2(300, 300, 100, 4);\n}\n\nfunction Draw2(v1, v2, v3, v4) {\nfor (i=1; i<=numRings; i++) {\n ellipse(v1, v2, v3\/ i, v3 \/ i)\n}\n}\n\nfunction DRAWSOMETHING() {\nrect(100, 100, 100, 100) \/\/ Lol rekt\n}<\/pre>\n
*<\/em>“Robust” is a great adjective that, when talking about software, has a fairly specific and technical meaning. Robust software is software that works without depending on many assumptions or conditions. A program that crashes when an expected file is not found is not robust. A program that reports the missing file, prompts the user to find the file, or presses on using reasonable default values is more robust.<\/p><\/body><\/html>\n","protected":false},"excerpt":{"rendered":"
A great programmer makes their code clear, robust, efficient, and user-friendly. Code needs to be clear so others can read and understand your code. Code needs to be robust* to reduce the number of errors in your program. Code needs to be efficient to reduce the cost of your code. Code needs to be user-friendly … Continue reading “Do’s and Don’ts of Style”<\/span><\/a><\/p>\n","protected":false},"author":535,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":[],"_links":{"self":[{"href":"https:\/\/courses.ideate.cmu.edu\/15-104\/f2022\/wp-json\/wp\/v2\/pages\/134"}],"collection":[{"href":"https:\/\/courses.ideate.cmu.edu\/15-104\/f2022\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/courses.ideate.cmu.edu\/15-104\/f2022\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/courses.ideate.cmu.edu\/15-104\/f2022\/wp-json\/wp\/v2\/users\/535"}],"replies":[{"embeddable":true,"href":"https:\/\/courses.ideate.cmu.edu\/15-104\/f2022\/wp-json\/wp\/v2\/comments?post=134"}],"version-history":[{"count":10,"href":"https:\/\/courses.ideate.cmu.edu\/15-104\/f2022\/wp-json\/wp\/v2\/pages\/134\/revisions"}],"predecessor-version":[{"id":55252,"href":"https:\/\/courses.ideate.cmu.edu\/15-104\/f2022\/wp-json\/wp\/v2\/pages\/134\/revisions\/55252"}],"wp:attachment":[{"href":"https:\/\/courses.ideate.cmu.edu\/15-104\/f2022\/wp-json\/wp\/v2\/media?parent=134"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}