1.3. Tips for Writing Good Code
Over my many years as a digital designer, I had the opportunity to write many lines of code as well as review, modify, and inherit others' code. Through these sometimes hard experiences, I have developed some tips for writing good code. Some of the tips come from trying to remember code I previously wrote or understanding someone's code. As you become more experienced, you will discover tips that make writing, modifying, and reviewing code much easier.
1.3.1. Tip 1. Use Comments to Convey Information about the Code
Comments are a very important part of coding. You should provide comments as a way of conveying pertinent information about the line or section of code, see Example 1-1. It is so easy to remember ...
Get FPGAs 101 now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.