คำถามติดแท็ก code-documentation

5
codestyle; ใส่ javadoc ก่อนหรือหลังคำอธิบายประกอบ?
ฉันรู้ว่ามันไม่ใช่ประเด็นสำคัญที่สุดของปัญหา แต่ฉันเพิ่งรู้ว่าฉันสามารถใส่บล็อกความคิดเห็น javadoc ก่อนหรือหลังการเพิ่มความคิดเห็น สิ่งที่เราต้องการนำมาใช้เป็นมาตรฐานการเข้ารหัส? /** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired /** * This is a javadoc comment after the annotation */ private MyOtherClass other; }

3
JSDoc: ส่งคืนโครงสร้างวัตถุ
ฉันจะบอก 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 …

5
วิธีจัดทำเอกสารประเภทสตริงใน jsdoc ด้วยค่าที่เป็นไปได้ที่ จำกัด
ฉันมีฟังก์ชันที่ยอมรับพารามิเตอร์สตริงหนึ่งตัว พารามิเตอร์นี้สามารถมีค่าที่เป็นไปได้ที่กำหนดไว้เพียงไม่กี่ค่าเท่านั้น วิธีที่ดีที่สุดในการจัดทำเอกสารแบบเดียวกันคืออะไร? ควรกำหนด shapeType เป็น enum หรือ TypeDef หรืออย่างอื่น? Shape.prototype.create = function (shapeType) { // shapeType can be "rect", "circle" or "ellipse"... this.type = shapeType; }; Shape.prototype.getType = function (shapeType) { // shapeType can be "rect", "circle" or "ellipse"... return this.type; }; ส่วนที่สองของปัญหาคือค่าที่เป็นไปได้ของshapeTypeไม่เป็นที่รู้จักในไฟล์ที่กำหนดshapeTypeเป็นสิ่งที่คุณแนะนำ มีไฟล์หลายไฟล์ที่มาจากนักพัฒนาหลายคนซึ่งอาจเพิ่มค่าที่เป็นไปได้ของshapeTypeไฟล์. PS: กำลังใช้ jsdoc3
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.