JSDoc

JSDoc สามารถผลิตเอกสารในจำนวนกว้างของรูปแบบข้อความเช่น HTML, XML, JSON, และอื่น ๆ .

JSDoc ก่อนหน้านี้ทราบว่าเป็นเครื่องมือ JsDoc.

รุ่น JSDoc อดีตใช้ Java เพื่อแยกรหัสที่มา, สารสกัดจากความคิดเห็นและสร้างเอกสาร ตั้งแต่สาขา 3.x Node.js ใช้แทน.

นอกจาก Node.js, JSDoc ยังสามารถทำงานร่วมกับเครื่องยนต์แรดของ Mozilla เช่นกัน.

การใช้ JSDoc ถูกต้องตรวจสอบเอกสารสำหรับข้อมูลเกี่ยวกับวิธีการจัดรูปแบบรหัสต้นฉบับของคุณแสดงความคิดเห็นเพื่อให้พวกเขาสามารถตรวจพบและนำมาใช้โดยเครื่องมือ JSDoc ของ.

มีอะไรใหม่ ในข่าวประชาสัมพันธ์ฉบับนี้.

• ตอนนี้สามารถเรียกใช้ JSDoc ใน Node.js
• ตอนนี้สามารถใช้ @interface และแท็ก @implements เพื่อการเชื่อมต่อและการใช้งานเอกสารของพวกเขา.
• @inheritDoc ปิดคอมไพเลอร์และแท็ก @override ได้รับการสนับสนุนในขณะนี้.
• ถ้าความคิดเห็น JSDoc สัญลักษณ์รวมถึงแท็ก @mixes ทั้งหมด mixins ในขณะนี้ปรากฏในเอกสารสัญลักษณ์ของ.
• JSDoc ในขณะนี้สามารถบันทึกข้อมูลไปยังคอนโซลขณะที่มันวิ่ง (เช่นชื่อของแต่ละแฟ้มที่ JSDoc แยกวิเคราะห์) เข้าสู่ระบบข้อมูลนี้เรียก JSDoc กับธง --verbose.
• ตอนนี้สามารถใช้ไฟล์ใด ๆ ที่เป็นแพคเกจหรือไฟล์ README สำหรับเอกสารของคุณ ใช้ -P / การ - แพคเกจและ / -R / -. ธง README เพื่อระบุแพคเกจและไฟล์ README
• พิมพ์แม่แบบเริ่มต้นที่และรูปแบบสีได้รับการปรับปรุงอย่างมีนัยสำคัญ.

มีอะไรใหม่ ในรุ่น 3.3.2:

• ตอนนี้สามารถเรียกใช้ JSDoc ใน Node.js.
• ตอนนี้สามารถใช้ @interface และแท็ก @implements เพื่อการเชื่อมต่อและการใช้งานเอกสารของพวกเขา.
• @inheritDoc ปิดคอมไพเลอร์และแท็ก @override ได้รับการสนับสนุนในขณะนี้.
• ถ้าความคิดเห็น JSDoc สัญลักษณ์รวมถึงแท็ก @mixes ทั้งหมด mixins ในขณะนี้ปรากฏในเอกสารสัญลักษณ์ของ.
• JSDoc ในขณะนี้สามารถบันทึกข้อมูลไปยังคอนโซลขณะที่มันวิ่ง (เช่นชื่อของแต่ละแฟ้มที่ JSDoc แยกวิเคราะห์) เข้าสู่ระบบข้อมูลนี้เรียก JSDoc กับธง --verbose.
• ตอนนี้สามารถใช้ไฟล์ใด ๆ ที่เป็นแพคเกจหรือไฟล์ README สำหรับเอกสารของคุณ ใช้ -P / การ - แพคเกจและ / -R / -. ธง README เพื่อระบุแพคเกจและไฟล์ README
• พิมพ์แม่แบบเริ่มต้นที่และรูปแบบสีได้รับการปรับปรุงอย่างมีนัยสำคัญ.

มีอะไรใหม่ ในรุ่น 3.3.0:

• ตอนนี้สามารถเรียกใช้ JSDoc ใน Node.js.
• ตอนนี้สามารถใช้ @interface และแท็ก @implements เพื่อการเชื่อมต่อและการใช้งานเอกสารของพวกเขา.
• @inheritDoc ปิดคอมไพเลอร์และแท็ก @override ได้รับการสนับสนุนในขณะนี้.
• ถ้าความคิดเห็น JSDoc สัญลักษณ์รวมถึงแท็ก @mixes ทั้งหมด mixins ในขณะนี้ปรากฏในเอกสารสัญลักษณ์ของ.
• JSDoc ในขณะนี้สามารถบันทึกข้อมูลไปยังคอนโซลขณะที่มันวิ่ง (เช่นชื่อของแต่ละแฟ้มที่ JSDoc แยกวิเคราะห์) เข้าสู่ระบบข้อมูลนี้เรียก JSDoc กับธง --verbose.
• ตอนนี้สามารถใช้ไฟล์ใด ๆ ที่เป็นแพคเกจหรือไฟล์ README สำหรับเอกสารของคุณ ใช้ -P / การ - แพคเกจและ / -R / -. ธง README เพื่อระบุแพคเกจและไฟล์ README
• พิมพ์แม่แบบเริ่มต้นที่และรูปแบบสีได้รับการปรับปรุงอย่างมีนัยสำคัญ.

มีอะไรใหม่ ในรุ่น 3.2.2 / 3.3.0-beta1:

• จ่าหน้าถดถอยใน JSDoc 3.2.1 ที่สามารถป้องกันการประกาศฟังก์ชั่นการประกาศจากแชโดว์ที่มีชื่อเดียวกันในขอบเขตด้านนอก.
• ถ้าชั้นเด็กแทนที่วิธีการในชั้นเรียนของผู้ปกครองที่ไม่มีการจัดเก็บเอกสารวิธีการแทนที่เอกสารวิธีการที่จะถูกคัดลอกในขณะนี้จากระดับผู้ปกครอง.
• ตอนนี้คุณสามารถใช้แท็กอินไลน์ในข้อความ Markdown ที่จัดรูปแบบ นอกจากนี้ JSDoc ตอนนี้ใช้เพียงตัวแยกวิเคราะห์ Markdown ทำเครื่องหมาย; ตัวแยกวิเคราะห์ markdown-js ถูกลบ.
• สำนวนประเภทนี้อาจรวมถึงช่วงที่กว้างมากของประเภทที่ทำซ้ำ นอกจากนี้คุณสามารถใช้คอมไพเลอร์ปิดของการปรับเปลี่ยน nullable และไม่ nullable กับชนิดทำซ้ำ ยกตัวอย่างเช่นการแสดงออกประเภทสตริง ... (ทำซ้ำสตริงที่ไม่ nullable) จะแยกกันอย่างถูกต้อง.

มีอะไรใหม่ ในรุ่น 2.4.0:

• ข้อผิดพลาดที่เพิ่มได้หลายสัญลักษณ์ที่มีชื่อเดียวกันคงที่ ไปที่เอกสาร.
• เพิ่มการสนับสนุนสำหรับตัวเลือกในการปราบปราม -m คำเตือนสำหรับเอกสารหลาย.
• เพิ่มแพทช์โดย brownsea42 เพื่อสนับสนุนการยกตัวแปรของผู้ใช้ในบรรทัดคำสั่ง.
• ข้อผิดพลาดที่เกิดจากการคงที่บางครั้งการเชื่อมโยงกับเหตุการณ์ที่ไม่ถูกต้อง.

ต้องการ

• เปิดใช้งาน JavaScript บนฝั่งไคลเอ็นต์
• Node.js 0.10 หรือสูงกว่า