คำถามติดแท็ก 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 …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

วิธีการทำเอกสารวิธีการที่มีพารามิเตอร์โดยใช้สตริงเอกสารคู่มือของงูใหญ่? แก้ไข: 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 ... นี่เป็นข้อตกลงที่นักพัฒนางูหลามส่วนใหญ่ใช้หรือไม่ Keyword arguments: <parameter name> -- Definition (default value if any) …

139 python  documentation  documentation-generation