Updating software can generated tons of new problems and issues, and it is important that the designer of the software takes time during the original creation of the software to do things the right way rather than the short fast way.
So what are some of the things that a developer can do to help make the software easy to maintain??
1. Document everything. In code documentation is the single most important thing to help make software easy to maintain. Different people have different preferences on how exactly the documentation should be written, but no matter how you do it, documentation is key to making software easy to update.
2. A debug mode. When trying to fix software you need to see what the software is doing under the hood. Obviously what the software is actually doing shouldn't be shown to the normal user, but when you go to fix a problem having the software print information to the console or a log file can be invaluable. Also a debugging mode can switch off all "try-catch" statements so that the software actually fails when and where the problem actually exists.
3. Functions/Methods that do just one central thing.
4. Automated tests.
5. Give methods, fields, parameters, classes, and namespaces meaningful names.
What do you think? Tell me in comments below.
No comments:
Post a Comment