- Joined
- Nov 12, 2015
- Messages
- 11,802
- Country Flag
- Club or Nation
Sorry. I thought we'd all been educated...Caecilius est in horto. Romanes eunt domus.
Sorry. I thought we'd all been educated...Caecilius est in horto. Romanes eunt domus.
Sorry. I thought we'd all been educated...
Newsflash passing of one of your major distributors for your platform is a terrible idea.
Yeah - well - I'm trying to get our devs onto using Doxygen - and then generate the documentation right out of the code comments.There is some philsophy talk recently about where the code itself is documentation the only thing you need to produce extensive documentation for is external interfaces and how they work. I see some merit in that I've extensively designed stuff as a starting point in the past and that's a great starting block but reality is that design has had to be modified a huge amount when reality hit it, in the embedded world sometimes chips don't work how you read them to and scope creep is always a thing. Getting access to code with documented external interfaces always helps way more than any design document.
Plus the cost of updating documentation is probably not a huge differential to the the onboarding process.
To paraphase David Fincher "Software isn't finished its abandoned"
Yeah I've been there, developer buy in is always the hardest part. I think you can over doxygen something and it leads to crap documentation/comments with no useful dececenable information. People can ver very lazy of they are forced to do it.Yeah - well - I'm trying to get our devs onto using Doxygen - and then generate the documentation right out of the code comments.
Which kinda forces the things you do want to be current and accurate:
(i) The interfaces (as you rightly say) for testing the module in question and for others designing around the module in question.
(ii) The commentary for any developer coming in years later to maintain it.
Dave Chapelle brought Elon out on stage at his show last night and ended up getting booed by the majority of the 18k crowd, lol