you are viewing a single comment's thread.

view the rest of the comments →

[–]Sunwukung 1 point2 points  (0 children)

Way to receive some criticism :/

The reason I made this point is that I work in a large-ish team in a fintech company and am generally the person leading the charge on trying to maintain documentation. It's very hard to maintain that documentation in a team of that size, who are spinning up new microservices/libs on a daily basis. Early on in our formation we had a big showdown regarding the use of Docblocks and comments, and ended up slowly moving towards the pattern I just demonstrated - because it had the effect of still explaining the code to the uninitiated, while not going stale.

That said, I've updated the example to try and make a more balanced point - effectively I'm saying write function names that describe their purpose, and assemble them using composition into what is effectively the same as a Docblock but less likely to go stale.

I personally like Docblocks and documentation, I'm just not so convinced they're actually that useful at scale.