EG
Чаще всего конфликты в импортах получаются, да
Size: a a a
2020 September 14
EG
И они тривиальны, но бесят
P
в расте ввели странную привычку, что раз можно писать доки в коде, то в коде надо писать все доки
EG
в расте ввели странную привычку, что раз можно писать доки в коде, то в коде надо писать все доки
Документация вне кода устаревает быстрее.
EG
Плюс нужно поддерживать два места, в которых ты пишешь документацию — зачем?
P
Чаще всего конфликты в импортах получаются, да
согласен, при этом и самые проблемные конфликты, то дубликат сделаешь, то удалишь лишнее, благо иде подсказывает, но для раста хуёво
P
Плюс нужно поддерживать два места, в которых ты пишешь документацию — зачем?
есть разные уровни документации
EG
В идеале вся документация должна быть кодом
EG
Если так не получается, то она должна быть хотя бы рядом с кодом, в комментариях
P
В идеале вся документация должна быть кодом
документация кода
EG
В идеале вся документация должна быть кодом
Кодом — в плане, буквально кодом. Сигнатурами.
P
есть документация, которая к коду не относится
EG
Документацию API, например, вполне реально генерировать из кода
EG
Плюс комментариев
P
есть документация, которая к коду не относится
например вот: https://docs.rs/galois_2p8/0.1.1/galois_2p8/ вот это всё к коду не имеет никакого отношения, это тупо вырезка из учебника
P
к коду там относится единственный (последний) параграф
EG
И что? Мне всё равно удобно прочитать это на docs.rs, а не скакать по двум ресурсам
P
И что? Мне всё равно удобно прочитать это на docs.rs, а не скакать по двум ресурсам
да, но это не должно быть написано в файле с кодом
P
Почему?
потому, что это не относится к коду никак, и писать такое лучше не программистам