Что является предпочтительным методом комментария объектов JavaScript и [закрытых] методов
Вот список ссылок API для получения вашей статистики:
Facebook: https://api.facebook.com/method/links.getStats?urls=%%URLL %% & amp; format = json Reddit: http://buttons.reddit.com/button_info.json?url=%%URL%% LinkedIn: http: // www.linkedin.com/countserv/count/share?url=%%URL%%&format=json Digg: http://widgets.digg.com/buttons/count?url=% % URL %% Вкусный: http://feeds.delicious.com/v2/json/urlinfo/data?url=%%URL%% StumbleUpon: http: / /www.stumbleupon.com/services/1.01/badge.getinfo?url=%%URL%% Pinterest: http://widgets.pinterest.com/v1/urls/count.json?source = 6 & amp; url = %% URL %%
blockquote>Изменить: Удалена конечная точка Twitter, так как она устарела.
Изменить: Facebook REST API устарел
4 ответа
Существует JSDoc
/**
* Shape is an abstract base class. It is defined simply
* to have something to inherit from for geometric
* subclasses
* @constructor
*/
function Shape(color){
this.color = color;
}
Предложения Yahoo YUIDoc.
Это хорошо документируется, поддерживается Yahoo и является приложением Node.js.
Это также использует много того же синтаксиса, таким образом, не много изменений должны были бы быть внесены для движения от одного до другого.
Попытайтесь вставить следующее в файл JavaScript в Visual Studio 08 и игре вокруг с ним:
var Namespace = {};
Namespace.AnotherNamespace = {};
Namespace.AnotherNamespace.annoyingAlert = function(_message)
{
/// <param name="_message">The message you want alerted two times</param>
/// <summary>This is really annoying!!</summary>
alert(_message);
alert(_message);
};
Intellisense в изобилии!
[еще 114] информация об этом (включая то, как сослаться на внешние файлы JavaScript для использования в крупных библиотеках) может быть найдена на блог .Scott Gu
Использование тройного комментария в первом примере на самом деле используется для внешних инструментов документации XML и (в Visual Studio) intellisense поддержка. Все еще действительный комментарий, но его специальное предложение:) Фактический комментарий 'оператор'//единственное ограничение, там то, что для одной строки.
второй пример использует блок стиля C, комментирующий, который допускает комментарий через несколько строк или посреди строки.