Good Software & Debugging Practices
Here is a list of software guidelines that may serve you well.
Always and I mean always comment your code. Comment it to the level a nonprogramer could understand it.
Keep a change log.
Find a variable convention that suits you and stick with it.
Do not use generic variables. Ever.
Do not make sphagetti code .
Expect the worst out of your end user. Remember they may be hackers trying to exploit your program (unlikely at this point of being a developer but it never hurts to take it into account)
Validate user and file input.
Make your programs a bit flexible by including settings files.
Always make sure your end user understands the scope and limitations of your program.
Make software diagrams using free online software such as draw.io
Debugging
Keep a log file or log databases.
Make human readable error message.
Use Textwindow.Writeline to have a look inside your program.
Alternatively if you have the Litdev extension installed you can use LDDebug.
Sometimes a failure does not end a program. Make sure to end the program if the error is critical in some manner. Also remember to make sure it is graceful and to log the error in some manner.
If a problem is stumping you take a break , go outside , do something other than debugging. It will clear your mind. Also talk to a friend about the problem and explain it to them as simplfy and detail filled as possible. This may help you solve the problem
If you have any things you wish to be seen added to this list contact us using our email form in the contact section!
