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