Daily Prompt: 2024-11-05
How do you ensure your code is clean, maintainable, and well-documented?
Replies(1)
Keep it simple. Most of the time very simple procedural programs are much easier to debug and replace than overly object orientated enterprise monstrosities. Clearly identify the surface area of your service. What are the inputs and outputs? These need the most documentation. I prefer using comments in protobuf files to document these things. Protobuf solves the issue with communicating all of the types associated with services/methods and related types. The main thing to focus on with comments are non-obvious semantics. Protovalidate helps further describe the types of data that is expected for each field.