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

Tôi biết rằng đó không phải là vấn đề quan trọng nhất, nhưng tôi chỉ nhận ra rằng tôi có thể đặt khối nhận xét javadoc trước hoặc sau chú thích. Điều gì chúng ta muốn áp dụng như là một tiêu chuẩn mã hóa? /** * This is a …

183 java  coding-style  annotations  javadoc  code-documentation 

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 

Tôi đang có một hàm chấp nhận một tham số chuỗi. Tham số này chỉ có thể có một trong một vài giá trị có thể được xác định. Cách tốt nhất để ghi lại tài liệu giống nhau là gì? ShapeType có nên được định nghĩa là enum hoặc …

96 google-closure-compiler  google-closure  jsdoc  code-documentation