Инструмент Linux для проверки написания комментариев в исходном коде c / c ++

Question

Какое программное обеспечение вы предлагаете для проверки правописания комментариев, содержащихся в исходном коде c / c ++ (особенно комментариев doxygen)? Я ищу что-то, что будет анализировать только комментарии, чтобы я мог легко находить ошибки и исправлять их.

Вопрос общий, но если быть более конкретным, я использую CodeLite IDE.

Answer 1

Emacs имеет ispell-comments-and-strings, который довольно хорошо работает внутри редактора.Он использует механизм подсветки синтаксиса для идентификации комментариев и строк, поэтому он работает с любым языком, для которого у вас есть хорошая подсветка.

Не знаю, как вы будете работать с IDE.

Answer 2

Мне тоже нужно было что-то подобное. Он должен был работать не только в Linux.

Я видел, что проверка орфографии часто сопряжена с IDE (как с eclipse). Однако мне нужен был инструмент, полностью независимый от любой среды IDE, потому что я хотел иметь возможность запускать его в автоматизированном / скриптовом контексте, таком как сборки Travis-CI или сборки AppVeyor CI.

Немного огляделся по поводу такого инструмента и затем решил написать свой.

Я придумал pyspellcode , который отвечает этим потребностям. Это скрипт на python, использующий clang и hunspell, который должен по крайней мере легко работать на Linux. Сценарий:

1. запускает clang, чтобы получить вывод дампа AST,
2. читает информацию AST и находит узлы комментариев,
3. передает слова из них на hunspell для проверки, а затем
4. сообщает слова, которые не были распознаны.

Что меня удивило, так это то, как глубоко Clang анализирует комментарии C ++ даже в элементах doxygen и встроенной разметке HTML. Это позволило использовать AST clang для таких вещей, как игнорирование слов, вложенных в <code>... блоков, и я воспользовался этим в скрипте.

Сценарий доступен на GitHub как проект с открытым исходным кодом, лицензированный Zlib. На данный момент это всего лишь альфа-программа, в которой есть хотя бы одна ошибка синтаксического анализа, но если она будет интересна, я отдам ей больше приоритета.

Надеюсь, это поможет!

Answer 3

Хорошее место, чтобы проверить комментарии о кислороде - это, кажется, сам кислород. Но это не проверяет орфографию:

Быстрый, обходной путь, который мне приходит в голову и который, я думаю, может сработать, - это сгенерировать вывод LaTeX, а затем использовать LaTeX для проверки орфографии. Другим решением может быть использование формата вывода Perl модуля doxygen и запись некоторого кода на Perl для проверки орфографии (например, с Aspell или Ispell).

С IDE это намного проще, потому что любая приличная IDE должна поддерживать проверку орфографии для комментариев к документам (например, Eclipse CDT)