Строки документации и обычные комментарии в коде отличаются по назначению и целевой аудитории. 12
Комментарии предназначены для объяснения происходящего в коде разработчикам, которые хотят его расширить. 1 Обычно такие комментарии не превращают в документацию, так как они касаются самого кода, а не его использования. 1 Комментарии помогают читателю лучше понять код, его назначение и дизайн. 2
Строки документации предназначены для людей, которые собираются использовать код, не нуждаясь и не желая знать, как он работает. 1 Строки документации можно превратить в реальную документацию. 1 Они описывают функциональность кода, а не его реализацию. 1
Таким образом, можно сказать, что код объясняет, как что-то сделать, а комментарии — почему. 1