How do you document your code at work?

Question

This has been different at literally every company I've worked at, and it's never been good.Specifically curious about how internal technical/code/product documentation is written and maintained.If you like the internal documentation at your company: what's so great about it?

byoung2 · Accepted Answer

Every new feature at TrueCar requires extensive documentation. A lot of our libs are open source so they need good docs. Here is an example of our UI component library's docs:https://www.truecar.com/battery-pack/introduction

thisistheend123 · Answer

I guess putting detailed comments within the code are the best form of documentation.The flow of code and detailed comments about it right there in the flow help the readability of code. Also it's easier to change the comments when code changes because its all there in a single file. Makes reviews easier.

How do you document your code at work?

This has been different at literally every company I've worked at, and it's never been good.
Specifically curious about how internal technical/code/product documentation is written and maintained.
If you like the internal documentation at your company: what's so great about it?

Every new feature at TrueCar requires extensive documentation. A lot of our libs are open source so they need good docs. Here is an example of our UI component library's docs:
https://www.truecar.com/battery-pack/introduction