Câu hỏi được gắn thẻ «documentation-generation»

Nhiều ngôn ngữ hỗ trợ nhận xét tài liệu để cho phép trình tạo (như javadochoặc doxygen ) tạo tài liệu mã bằng cách phân tích cùng mã đó. Swift có bất kỳ tính năng nhận xét tài liệu loại như thế này?

238 swift  documentation-generation 

Làm thế nào tôi có thể nói với JSDoc về cấu trúc của một đối tượng được trả về. Tôi đã tìm thấy @return {{field1: type, field2: type, ...}} descriptioncú pháp và thử nó: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

Làm cách nào để ghi lại các phương thức với các tham số bằng chuỗi tài liệu của Python? EDIT: PEP 257 đưa ra ví dụ này: 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) …

139 python  documentation  documentation-generation