- xml - AJAX/Jquery XML 解析
- 具有多重继承的 XML 模式
- .net - 枚举序列化 Json 与 XML
- XML 简单类型、简单内容、复杂类型、复杂内容
我正在记录一个 JavaScript API。我正在遵循谷歌风格指南,但我没有发现任何关于标签顺序的信息。
我通常记录这样一个变量:
/**
* @description Radius of the circle
* @private
* @memberOf Circle
* @type {Number}
* @default
*/
Circle.prototype._radius = 1;
如您所见,我使用自己的顺序编写标签,这是我认为最直观的顺序。
这是按字母顺序排列标签的同一文档:
/**
* @default
* @description Radius of the circle
* @memberOf Circle
* @private
* @type {Number}
*/
Circle.prototype._radius = 1;
尽管有明确定义的顺序(按字母顺序),但我发现这有点令人困惑,因为它打乱了评论的自然顺序。这就是为什么我正在寻找一种方法来编写带有特定官方命令的标签。
这些标签是否有官方订单?
Cảm ơn
câu trả lời hay nhất
JSDoc 标签没有官方规定。我倾向于先放置更通用的标签,然后放置更具体的标签,类似于您的第一个示例。
一般来说,JSDoc 不关心标签的顺序,但也有一些值得注意的异常(exception):
@desc
(hoặc @description
)标记提供描述,就像您在示例中所做的那样。@param
标记来记录函数参数时,参数必须使用与函数签名相同的顺序。
关于javascript - 文档中是否有 JSDoc 标签的正式命令?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/24306839/
Tôi có một tệp .sln chứa một số dự án trong đó. Để đơn giản, hãy gọi chúng là... Dự án A Dự án B Dự án C...trong đó A là dự án chính tham chiếu đến B và C. Mục tiêu của tôi là cập nhật tập lệnh xây dựng cho ProjectA
Tôi đã cài đặt Magento và tôi muốn biết cách tạo tài liệu API hoàn chỉnh, ví dụ: tài liệu tại http://docs.magentocommerce.com/ được tạo bằng phpdoc. Nó có được bao gồm trong Magento không?
Tôi thường sử dụng ide gia đình jetbrains. Rất hữu ích khi tạo tài liệu cho một hàm, chỉ cần nhập /** Cách tạo thẻ tùy chỉnh khi tạo tài liệu, chẳng hạn như thẻ @date. Câu trả lời hay nhất JavaScript, Java: st
Tôi đang cố gắng tạo tài liệu bằng thư viện jOpenDocument. Tôi đã thực thi ví dụ này để tạo bảng tính - mã sẽ biên dịch và chạy tốt nhưng khi tôi cố gắng sử dụng Excel Office 2012 hoặc Google Doc
Giống như tiêu đề. Có hình ảnh nào giới thiệu cấu trúc của HTML DOM không? Câu trả lời hay nhất DOM (Mô hình đối tượng tài liệu) bắt đầu bằng nút tài liệu. Nó được gọi là "nút gốc". Quan sát cây sau (nodeType tương ứng trong ngoặc): [HTMLDocument]
Tôi thích ColdFusion Builder. Nhưng tôi không thích tài liệu CF9 chỉ trợ giúp. Có cách nào để thay đổi điều này để có tài liệu ColdFusion 8 không? Câu trả lời hay nhất http://livedocs.adobe.c
Câu hỏi này đã có câu trả lời ở đây: Hậu quả của đoạn javascript này là gì? (4 câu trả lời) Đã đóng 9 năm trước. Tôi thấy một số tập lệnh jQuery được nhúng
Tôi có một tệp XML chứa dữ liệu cần được điền vào tài liệu Word. Tôi cần tìm cách xác định một mẫu có thể được sử dụng làm đường cơ sở để điền dữ liệu từ tệp XML và tạo tài liệu đầu ra. Tôi tin rằng có hai cách để làm điều này. tạo nên
Tôi đang cố gắng tìm tài liệu chi tiết về cách sử dụng AVAudioEngine. Có ai biết tôi có thể tìm thấy nó ở đâu không? Tôi đã tìm thấy cái này, nhưng nó có vẻ rất thô sơ so với nội dung UI được ghi chép đầy đủ. https://developer.a
Tôi ngày càng khó chịu và thất vọng với tài liệu Tensorflow. Tôi đã tìm kiếm trên Google tài liệu về tf.reshape và tôi được dẫn đến một trang chung như ở đây. Tôi muốn xem chi tiết về tf.reshape chứ không phải toàn bộ
Tôi đã làm theo hướng dẫn này: http://moxleystratton.com/clojure/clojure-tutorial-for-the-non-lisp-programmer và sau đó xem qua đoạn mã này: bạn
Cách ghi lại một mảng đối tượng trong swagger. Đây là mã của tôi nhưng tôi không biết cách truy cập dữ liệu trong mảng đối tượng. { "first_name":Sam", "last_name":Smith",
Có thứ gì như JavaDocs cho Javascript không? Khi tôi nhấn ctrl+space trong netbeans IDE để viết javascript, tài liệu javascript của đối tượng được chỉ định sẽ xuất hiện.
đóng cửa. Câu hỏi này không tuân thủ các nguyên tắc của Stack Overflow. Hiện tại nó không chấp nhận câu trả lời. Chúng tôi không cho phép các câu hỏi tìm kiếm đề xuất về sách, công cụ, thư viện phần mềm, v.v. Bạn có thể chỉnh sửa câu hỏi của mình để trả lời bằng sự kiện và trích dẫn. Đóng cửa 5 năm trước.
Tôi cần thứ gì đó giống như di truyền trong JavaScript. Bạn có suy nghĩ gì về điều này không? Tôi cần chức năng trình duyệt chéo. Tôi đã tìm thấy cái này: heredoc = '\\\zzz\\
Tài liệu WSDL chứa một loạt các tài liệu XML đơn giản có thể mô tả định nghĩa về cấu trúc tài liệu WSDL. Tài liệu WSDL sử dụng các thành phần chính sau để mô tả một dịch vụ web.
Có tài liệu về ocropus không? Tôi đang tìm lời giải thích về các hàm sau: make_SegmentPageByRAST(): Segment() RegionExtractor(): setPageLines(
Câu hỏi này đã có câu trả lời ở đây: Tìm hiểu các sự kiện và trình xử lý sự kiện trong C# (13 câu trả lời) Đã đóng 4 năm trước. Tôi đang sử dụng NRECO và ffmpeg để xem
Tôi đang cố truy cập máy chủ công nhân để sử dụng với ứng dụng có tên Spotfire. Đồng nghiệp của tôi đã chuyển điều này cho tôi và đã được vài tuần rồi và tôi gặp vấn đề với đề xuất của anh ấy. Trên thực tế, khi tôi chạy ứng dụng web của mình qua localhost
Tài liệu Elm không đưa ra ví dụ về cách sử dụng, vì vậy thật khó để hiểu thông số kỹ thuật của loại có ý nghĩa gì. Ở một số nơi tôi thấy "a" được sử dụng làm mã định danh tham số, ví dụ: Platform.Cmd : map : (a -> msg) -> Cmd a -> Cmd
Tôi là một lập trình viên xuất sắc, rất giỏi!