タグ付けされた質問 「documentation-generation」

多くの言語はドキュメントコメントをサポートしており、ジェネレーター（javadocまたはdoxygen）が同じコードを解析してコードドキュメントを生成できるようにしています。 Swiftにはこのようなタイプのドキュメントコメント機能がありますか？

238 swift  documentation-generation 

返されるオブジェクトの構造をJSDocに通知するにはどうすればよいですか。私は@return {{field1: type, field2: type, ...}} description構文を見つけて試しました： /** * 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 * event. * @param {string} [type="page"] * A string representing the type of …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

Pythonのドキュメント文字列を使用して、パラメーターを含むメソッドをドキュメント化する方法は？ 編集： PEP 257はこの例を示します： 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 ... これはほとんどのPython開発者が使用する規則ですか？ Keyword arguments: <parameter name> -- Definition (default value if any) …

139 python  documentation  documentation-generation