เห็นในกลุ่ม iOS Developer Thailand มีการสอบถามเรื่อง
การสร้าง document แบบอัตโนมัติจาก comment ใน code หรือไม่ ?
ซึ่งเป็นสิ่งที่ทาง Apple ลืมมั้ง !! ว่าต้องทำอย่างไร
แต่มีคนทำเครื่องมือมาช่วยหลายตัว
ยกตัวอย่างเช่น Jazzy สร้างโดยทีมพัฒนาของ Realm
ซึ่งใช้งานมาก ๆ ดังนี้
ขั้นตอนที่ 1 เขียน comment ใน code ซะ
ขั้นตอนที่ 2 ทำการติดตั้ง Jazzy
$gem install jazzy
ขั้นตอนที่ 3 ทำการสร้างเอกสารด้วย jazzy
$jazzy
ผลที่ได้คือ สร้างเอกสารไว้ใน folder docs
เอกสารออกมาหน้าตาแบบนี้
ปัญหาที่เห็นคือ private method/function ไม่มีในเอกสาร !!
ดังนั้นถ้าต้องการสามารถเปลี่ยนแปลงคำสั่งดังนี้
jazzy --min-acl private
จะได้เอกสารสร้างดังนี้
คำถามต่อมา อยากเปลี่ยน them ได้ไหม ?
โดยค่า default จะเป็น theme app
แต่ jazzy ก็มี them ให้ใช้อีกตัวคือ fullwidth
สามารถเปลี่ยน them ด้วยคำสั่ง
jazzy --min-acl private --theme fullwidth
ได้เอกสารหน้าตาแบบนี้
ตัวอย่างของ source code อยู่ที่ Github
เพียงเท่านี้ก็ได้เอกสารแบบสวยๆ แล้วนะครับ
เพียงเท่านี้ก็ได้เอกสารแบบสวยๆ แล้วนะครับ