«documentation-generation» etiketlenmiş sorular

Birçok dil , bir üreticinin (benzer veya doxygen gibi ) aynı kodu ayrıştırarak kod belgeleri oluşturmasına izin vermek için belge yorumlarını destekler .javadoc Swift'in böyle bir belge açıklama özelliği var mı?

238 swift  documentation-generation 

JSDoc'a döndürülen bir nesnenin yapısı hakkında nasıl bilgi verebilirim? @return {{field1: type, field2: type, ...}} descriptionSözdizimini buldum ve denedim: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event or a jQuery event wrapping such an * …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

Python'un belge dizelerini kullanarak yöntemleri parametrelerle nasıl belgeleyebilirim? EDIT: PEP 257 bu örneği verir: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part (default 0.0) """ if imag == 0.0 and real == 0.0: return complex_zero ... Bu …

139 python  documentation  documentation-generation