Piszę własną bibliotekę dla projektu w pracy dla aplikacji przeglądarki i mam ten sam stary problem, decydując, jak skomentować kod.

Próbuję śledzićJsDoc składnia, ale prawdopodobnie będzie kontynuowaćKompilator zamknięcia Google sposób. Mogę skończyć używając dwóch znaczników @return i @returns w dokumentacji, tylko ze względu na przenośność (kiedy ustawiam automatyczne generowanie dokumentacji).

Teraz pytanieJak udokumentować zwrot niestandardowego anonimowego obiektu z funkcji? Na przykład:

return {
    username: 'username',
    password: 'password',
    enabled:  true
};

JsDoc ma przykład tego, jak można udokumentować @param, aby oczekiwać obiektu z określonymi polami, ale nie z tagiem @returns. Podobnie dokumentacja kompilatora Google Closure typu rekordu jest niejasna i nie ma przykładu, jak go rozwiązać.