ท่ามกลางคุณสมบัติใหม่ที่ประกาศในXcode 8เราสามารถดูได้
"สร้างเอกสารวิธีใช้ด่วนอัตโนมัติ":
นี่คือจุดสิ้นสุดของเอกสารคู่มือรหัสเหมือนที่เราสามารถเรียนรู้ในบทความนี้จาก NSHipsterหรือไม่?
ใครสามารถสรุปข้อดีข้อเสียของคุณลักษณะใหม่นี้ มันแทนที่เครื่องมือเช่น Jazzyหรือไม่?
ฉันไม่พบข้อมูลเพิ่มเติมเกี่ยวกับคุณลักษณะใหม่นี้
คำตอบ:
นี่หมายถึงคุณสมบัติ Xcode 8 (และใหม่กว่า) ซึ่งคุณสามารถเลือกวิธีการดังนี้:
func foo(bar: Int) -> String { ... }
... จากนั้นกด⌘+ option+ /(หรือเลือก "โครงสร้าง" » "เพิ่มเอกสารประกอบ" จากเมนู "ตัวแก้ไข" ของ Xcode) และจะสร้างเทมเพลตความคิดเห็นต่อไปนี้ให้คุณ:
/// <#Description#>
///
/// - parameter bar: <#bar description#>
///
/// - returns: <#return value description#>
เพียงแค่อำนวยความสะดวกในการเขียนเอกสารสำหรับความช่วยเหลือด่วน
หมายเหตุแม้ว่าลักษณะการทำงานนี้จะเปลี่ยนไปเล็กน้อยเมื่อเวลาผ่านไป Xcode สามารถระบุตำแหน่งที่เคอร์เซอร์ต้องอยู่เมื่อคุณพยายามทำสิ่งนี้ ตัวอย่างเช่นเคอร์เซอร์จะต้องอยู่ที่ใดที่หนึ่งในชื่อฟังก์ชันfooในตัวอย่างด้านบนเพื่อให้สิ่งนี้ใช้งานได้ หรือดับเบิลคลิกที่ชื่อฟังก์ชันแล้วกด⌘+ option+/
@IBActionวิธีการ แต่ใช้ได้กับทั้ง Objective-C และ Swift fine หากคุณยังคงประสบปัญหาและได้ลองใช้ขั้นตอนที่ง่อยตามปกติในการรีสตาร์ท Xcode และ / หรือรีบูตเครื่องของคุณคุณอาจต้องการโพสต์รายงานข้อบกพร่องบนซอฟต์แวร์เบต้านี้
sudo /usr/libexec/xpccachectlใน Terminal และรีสตาร์ท Mac ของคุณก่อนหรือส่วนขยาย Xcode อื่น ๆ จะ งาน. ดูบันทึกประจำรุ่น Xcode 8
สิ่งนี้น่าจะเกี่ยวข้องกับความจริงที่ว่าปุ่มลัดทั้งหมดที่มี '/' ไม่ทำงานในรุ่น XCode 8 ปัจจุบันหากแป้นพิมพ์ของคุณต้องการให้กด shift เพื่อรับ
เช่นบนแป้นพิมพ์ภาษาเยอรมัน '/' คือ shift + 7 การกด alt + cmd + shift-7 จะไม่ทำสิ่งใดสิ่งหนึ่ง หากคุณกำหนดเช่น cmd + shift + opt + d ก็ใช้ได้ดี
ทางลัด '///' ซึ่งน่าเสียดายที่ยังใช้งานไม่ได้ในตอนนี้อาจเป็นเพราะปลั๊กอิน XCode รุ่นเก่า VVDocumenter ซึ่งใช้ทางลัดนี้ทั้งหมด
คุณสมบัติที่ยอดเยี่ยม QA หมัดทางฝั่ง Apple