Some random information regarding commenting your code<\/p>\n
Is commenting required? or suggested?\r\nSimply yes. Always comment your code.\r\n\r\nNote: Commenting is always useful only when it is done right. \r\nBad commenting is worse than not commenting.\r\n\r\nWhat should you write in the comment?<\/strong>\r\n--------------------------------------\r\nWrite why the section of the code is required.\r\nwrite-What does the code section do.\r\nWrite it in plain english. Don't use any language syntax.\r\nIf you do not find what to write...then better check did you understand the \r\nrequirements of the assignment\/section? \r\nAlso check, are you sure your design\/logic will work? \r\nAlso, why your design\/code will work -- did you really understand. \r\nDo not write how the code works in comments but write why and what it does.\r\n\r\nWhy commenting is useful?<\/strong>\r\n-------------------------\r\nCommenting will make your code more readable to others.\r\nCommenting will help others to find out the right section of code to edit\/modify. \r\nAlso, understand the purpose of the program as well as sequence of the logic.\r\nIt will also help you to review\/(work on) your own code later\r\nIn many or most companies, you will hardly write codes from scratch, you have to \r\nwork on others' code. Hence, commenting is important\r\n\r\n\r\nRandom:<\/strong>\r\n--------\r\nUse a clear commenting style - easy to edit\r\nComment as you go\/code - do not leave commenting until the end of writing code\r\nIf you are worried that commenting will reduce performance...rather comment and \r\nuse tools to create release codes without comments\r\ncomment above the code -- not at the right\r\nvariable declaration may have comment at the right\r\nif you use any special trick that is not obvious from the code -- write it in \r\ncomments [a trick:we can do a right shift for divide by 2]\r\n\r\nComments and Pseudocode Programming Practice (PPP)<\/strong>\r\n----------------------------------------------------\r\nComments and Pseudocode Programming Practice (PPP) go hand in hand.\r\nwhat is Pseudocode Programming Practice (PPP)?\r\n1. Write your logic in plain english may be as a paragraph\r\n2. Decompose it step by step into as fine grained that it can not be decomposed \r\nfurther. (The paragraph will be converted to lines of steps)\r\n3. comment each line\/step (use comment sign like \/\/)\r\n4. After each line\/comment write the corresponding code.<\/pre>\nFrom: http:\/\/sitestree.com\/?p=3537
Categories:Root
Tags:
Post Data:2016-07-08 16:05:38<\/p>\n\t\tShop Online: https:\/\/www.ShopForSoul.com\/<\/a>
\n\t\t(Big Data, Cloud, Security, Machine Learning): Courses: http:\/\/Training.SitesTree.com<\/a>
\n\t\tIn Bengali: http:\/\/Bangla.SaLearningSchool.com<\/a>
\n\t\thttp:\/\/SitesTree.com<\/a>
\n\t\t8112223 Canada Inc.\/JustEtc: http:\/\/JustEtc.net (Software\/Web\/Mobile\/Big-Data\/Machine Learning) <\/a>
\n\t\tShop Online: https:\/\/www.ShopForSoul.com\/<\/a>
\n\t\tMedium: https:\/\/medium.com\/@SayedAhmedCanada <\/a><\/p>\n","protected":false},"excerpt":{"rendered":"Some random information regarding commenting your code Is commenting required? or suggested? Simply yes. Always comment your code. Note: Commenting is always useful only when it is done right. Bad commenting is worse than not commenting. What should you write in the comment? ————————————– Write why the section of the code is required. write-What does … <\/p>\n