Мне нравится хорошая документация для исходного кода, но я ненавижу комментарии к документации в коде. Я нашел решения для отделения кода от документации для других языков, но не для Rust. Итак, есть ли какое-либо решение отделить исходный код от документации в Rust там?Можно ли отделить исходный код от комментариев документации в Rust?
Боюсь, что нет. Я слежу за экосистемой ржавчины, и я никогда не видел даже упоминания ничего подобного. Что касается соответствующей заметки, я думаю, что комментарии должны быть в коде, и если вы пишете открытый код в Rust, я бы посоветовал придерживаться стандартных способов делать что-то, только ради других людей. Например. Я яркий защитник отступов табуляции, а не пробелов («Отступ с вкладками, выравнивание с пробелами»), но из-за того, что сообщество Rust поселилось (явно уступает :)), я использую пробелы в своих проектах Rust. Это не соответствует моим предпочтениям, но, преодолевая это, он помогает моим и другим людям легче работать при сотрудничестве.
В качестве обходного решения я хотел бы предложить сделать ваш редактор просто агрессивно сбрасывать комментарии.
Это настоящий позор! Потому что мне нравится отделять все элементы кодирования, такие как тесты, код и документацию. Я не понимаю соглашение о написании документации в коде. Комментарии для сложных функций полезны, но не комментарии к документам. Я думаю, что он делает код нечитаемым. Тем не менее, большое спасибо. –
@NarabX Имея документацию рядом с документами, она также помогает поддерживать ее в актуальном состоянии. Я могу легко представить, что кто-то изменил подпись функции и забыл обновить ее в документе. Эта проблема смягчается, когда документ находится до 2 строк перед функцией. И если вы найдете код нечитаемым со слишком большим количеством документов, просто настройте текстовый редактор, чтобы сбросить документы по умолчанию :) – mcarton
@mcarton Я понимаю, что вы имеете в виду, но насколько мне известно, люди игнорируют документ, даже если это перед функцией;) и иногда у меня нет доступа к моему любимому и сконфигурированному текстовому редактору. Итак, чтобы скомпоновать комментарии, это хороший способ обхода, но это не то, что я хочу. Спасибо за ваш отзыв. –
Если вы хотите, чтобы документация была отдельной, можете ли вы просто написать ее отдельно в инструменте, отличном от ржавчины? –
Я могу. Знаете ли вы хороший инструмент для этого? –
Есть много хороших инструментов, но они очень специфичны для личного вкуса - на самом деле это не вопрос ржавчины. :-) –