Методы организации / показа алгоритма, который закодирован в C или MATLAB - PullRequest
3 голосов
/ 17 ноября 2011

Есть ли рекомендации, как показать, что делает ваш код (C или MATLAB)? Представьте, что ваш код действительно длинный и в вашей программе много функций, как лучше всего документировать программу? Я знаю, что в Java IDE есть способ принимать комментарии и выкладывать их обратно в документ, который показывает все функции, а также их входы и выходы. Я не думаю, что C или MATLAB имеет эту функцию. На данный момент, я думаю, комментарии - единственный способ показать, что происходит в коде, но это может сбить читателя с толку, если ему придется просматривать необработанный код вместе с комментариями. Второй вариант - выписать алгоритм в текстовом редакторе, таком как Microsoft Word. Есть ли отраслевой стандарт для этого?

Спасибо!

Ответы [ 4 ]

5 голосов
/ 17 ноября 2011

Java использует JavaDoc .

Для C вы можете использовать Doxygen .

Я также видел это , что говорит о том, что вы можете использовать Doxygen и с matlab!

3 голосов
/ 17 ноября 2011

Последние версии MATLAB действительно имеют некоторые функции, очень похожие на это. Если вы реализуете свой код MATLAB в объектно-ориентированных классах, MATLAB будет автоматически генерировать документацию для вас, просто набрав doc myClassName - это действительно очень похоже на Doxygen. Если вы не используете объектно-ориентированный код, вы можете использовать MATLAB publishing для генерации документа из ваших скриптов и функций.

3 голосов
/ 17 ноября 2011

Мать всего грамотного программирования - http://www -cs-faculty.stanford.edu / ~ uno / cweb.html CWEB. Отец Кнут.

2 голосов
/ 17 ноября 2011
Поддержка

Doxygen * C 1002 * довольно хорошая.Он поддерживает комментарии в стиле JavaDoc и в стиле Qt, а также некоторые дополнительные функции.См. руководство для примеров того, как выглядит разметка.У меня нет готового примера вывода, но он вполне настраиваемый.

Проект Octave , который реализует язык и среду, которые фактически являются расширенным набором Matlab, использует texinfo для документирования его функций.Вы можете увидеть пример разметки в разделе Documentation Tips данного руководства.Я рекомендую прокрутить до конца страницы, чтобы просмотреть полный пример разметки, а не читать длинное объяснение, которое предшествует ему.У меня мало опыта работы с texinfo, кроме использования справки из Octave, но я считаю, что онлайн-руководство было сгенерировано из источников texinfo, поэтому оно кажется достаточно способным.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...