Комментарии Javascript для вызовов ajax
В настоящее время я использую комментарии в стиле phpDoc при документировании функций javascript, главным образом потому, что я привык к синтаксису и чувствую, что phpDoc - это хороший, всеобъемлющий стиль комментирования.
Одна вещь, которую это не покрывает, хотя - запросы Ajax (очевидно), и я задавался вопросом, был ли установлен стандарт для того, чтобы комментировать это? Или, если у кого-то есть предложения о том, как лучше прокомментировать, что делает звонок, что он должен вернуть и т. Д.
2 ответа
Чтобы придерживаться стиля phpdoc, я бы относился к вызову AJAX, как к функции, и в основном использовал свободное текстовое описание, чтобы описать детали того, что ожидается. Это то, что вы делаете с функциями, и не существует никакого стандарта для вызовов AJAX AFAIK, так что просто сделайте это. Может быть, вы могли бы начать один! Блог об этом или что-то.
Прочитайте эту замечательную статью о документации кода JavaScript и создании файлов документации @ dailyjs.com - она должна настроить вас на то, что вам нужно.