Я еще не определился с тем, насколько мне необходимо документирование кода и в каком объеме. С одной стороны, несложно добавить общие вещи вроде описание классов контроллеров. С другой стороны, они не добавляют ничего принципиально нового по сравнению с документацией API. Не хочется также засорять код однострочными комментариями, которые не будут ничего пояснять.
Возможное решение
В случае, если документирование кода оправдано, необходимо добавить описания классов и методов в случаях, где это необходимо. На мой взгляд, это следующие случаи:
Документирование кода
Описание задачи
Я еще не определился с тем, насколько мне необходимо документирование кода и в каком объеме. С одной стороны, несложно добавить общие вещи вроде описание классов контроллеров. С другой стороны, они не добавляют ничего принципиально нового по сравнению с документацией API. Не хочется также засорять код однострочными комментариями, которые не будут ничего пояснять.
Возможное решение
В случае, если документирование кода оправдано, необходимо добавить описания классов и методов в случаях, где это необходимо. На мой взгляд, это следующие случаи: