appledoc
2.2.1 build 1333
ประกาศสำคัญ: จำเป็นต้องมีผู้ทำงานร่วมกัน
appledoc เป็นเครื่องมือบรรทัดคำสั่งที่ช่วยให้นักพัฒนา Objective-C สร้างเอกสารซอร์สโค้ดที่คล้ายกับ Apple จากความคิดเห็นของซอร์สโค้ดที่มีรูปแบบพิเศษ ได้รับการออกแบบมาเพื่อรับความคิดเห็นของซอร์สโค้ดที่อ่านได้มากที่สุดเท่าที่จะเป็นไปได้สำหรับการป้อนข้อมูลและการใช้ความคิดเห็นตลอดจนซอร์สโค้ดโดยรอบเพื่อสร้างเอกสารที่ดึงดูดสายตาในรูปแบบของ HTML รวมถึงชุดเอกสาร Xcode ที่ได้รับการจัดทำดัชนีและเรียกดูได้อย่างสมบูรณ์ แม้ว่าจะมีเครื่องมือหลายอย่างที่สามารถสร้างเอกสาร HTML สำหรับ Objective-C ได้ แต่เครื่องมือทั้งหมดที่ฉันรู้จักกลับไม่บรรลุเป้าหมายขั้นต่ำที่อธิบายไว้ด้านล่าง
เป้าหมายหลักของ appledoc:
เพื่อให้ประสบการณ์ของคุณกับ appledoc ราบรื่นที่สุดเท่าที่จะเป็นไปได้ เราขอแนะนำให้คุณอ่านเอกสารทั้งหมดนี้ตลอดจนเอกสารออนไลน์ทั้งหมดที่กล่าวถึงในส่วน "การใช้ appledoc" ด้านล่างนี้
อนุญาตให้ใช้ appledoc ภายใต้เงื่อนไขที่ระบุไว้ในส่วนลิขสิทธิ์ที่ด้านล่างของไฟล์นี้!
ต้องการอัปเดตต่อไปหรือไม่? ติดตามเราบน Twitter - @gentlebytes
วิธีที่แนะนำคือการโคลนโปรเจ็กต์ GitHub และคอมไพล์เครื่องมือจาก Xcode เนื่องจากการโคลนโปรเจ็กต์ GitHub จะสร้างลิงก์ไปยังพื้นที่เก็บข้อมูลหลัก จึงทำให้การอัปเกรดในอนาคตง่ายขึ้นอย่างมากเช่นกัน หากต้องการติดตั้ง ให้พิมพ์ข้อความต่อไปนี้ใน Terminal:
git clone git://github.com/tomaz/appledoc.git
สิ่งนี้จะสร้างไดเร็กทอรี appledoc ภายในคุณจะพบ appledoc.xcworkspace พื้นที่ทำงาน Xcode; เปิดและคอมไพล์เป้าหมาย appledoc ซึ่งควรจะใช้งานได้ทันที อย่างไรก็ตาม ระบบของคุณต้องเป็นไปตามข้อกำหนดขั้นต่ำของระบบ ดูด้านล่าง ฉันขอแนะนำให้คุณคัดลอกผลลัพธ์ที่ปฏิบัติการได้ของ appledoc จากไดเรกทอรี build ไปยังหนึ่งในไดเรกทอรีในเส้นทางของคุณ ( echo $PATH ) เพื่อให้สามารถเข้าถึงได้ง่าย
ทางเลือก: Appledoc มีอยู่ในตัวเองและมีไฟล์เทมเพลตที่จำเป็น หากคุณต้องการแก้ไขค่าเริ่มต้นเหล่านี้จากไดเรกทอรีย่อยเทมเพลตไปยังตำแหน่งใดตำแหน่งหนึ่งที่คาดหวัง:
คุณยังสามารถใช้สคริปต์ install-appledoc.sh เพื่อทำการติดตั้งอย่างรวดเร็ว เปิด Terminal แล้วสลับไปที่ไดเรกทอรี appledoc พิมพ์คำสั่งต่อไปนี้:
sudo sh install-appledoc.sh (if you need templates add '-t default')
มันรวบรวม appledoc และติดตั้งไบนารีเป็น /usr/local/bin และเทมเพลต (หากต้องการ) เป็น ~/.appledoc ตามค่าเริ่มต้น คุณสามารถแทนที่ไดเร็กทอรีนี้ด้วยตัวเลือก -b และ -t ตามลำดับ ตัวอย่างเช่น:
sudo sh install-appledoc.sh -b /usr/bin -t ~/Library/Application Support/appledoc
อีกวิธีหนึ่งกับ Homebrew:
brew install appledoc
Homebrew ไม่ได้ติดตั้งเทมเพลตตามค่าเริ่มต้น
ใช้ appledoc --help เพื่อดูรายการสวิตช์บรรทัดคำสั่งทั้งหมด อ่านเพิ่มเติมเกี่ยวกับ appledoc บนเว็บไซต์ appledoc อ่านหน้าวิกิเพื่อดูบทความเชิงลึกเพิ่มเติม
ใช้ appledoc Google group เป็นฟอรัมสำหรับคำถามเกี่ยวกับการใช้งานหรือคำถามทั่วไปอื่นๆ
ใช้หน้าปัญหา Appledoc เพื่อส่งข้อบกพร่องและคำขอคุณสมบัติ ก่อนที่จะส่งปัญหาใหม่ ให้ตรวจสอบฟอรัมเพื่อดูว่าคำถามของคุณได้รับคำตอบแล้วหรือไม่ - เว้นแต่ว่าคุณจะสามารถยืนยันปัญหาของคุณว่าเป็นคำขอคุณลักษณะใหม่หรือข้อบกพร่องได้ คุณควรเริ่มต้นที่ฟอรัมเพื่อให้ปัญหา GitHub สะอาดตา อ่านประเด็นต่างๆ อย่างละเอียดเพื่อดูว่ามีปัญหาอยู่แล้วหรือไม่ และโหวตหรือเพิ่มความคิดเห็น (อย่าลืมเกี่ยวกับประเด็นที่ปิดแล้ว)
เพื่อให้เป็นปัจจุบัน เพียงไปที่ Terminal และ cd ลงในไดเร็กทอรี appledoc ออก git pull และคอมไพล์ appledoc.xcodeproj ใหม่ อย่าลืมเขียนทับไฟล์ปฏิบัติการ appledoc ที่คุณคัดลอกไปที่ $PATH :)
หากคุณต้องการคอมไพล์และรันเป้าหมาย AppledocTests (การทดสอบหน่วย) คุณต้องคัดลอกเฟรมเวิร์กทั้งหมดที่ระบุภายในกลุ่ม Libraries & Frameworks ไปยังไดเร็กทอรีเฟรมเวิร์กที่ใช้ร่วมกันก่อนที่จะสร้างเป้าหมายการทดสอบหน่วย! สิ่งนี้ไม่จำเป็นสำหรับการสร้างเครื่องมือ appledoc
คุณสามารถตั้งค่า Xcode เพื่อสร้างเอกสาร appledoc โดยอัตโนมัติ ค้นหาวิธีใช้ Run Script และ Build Phases ของโปรเจ็กต์ของคุณ
เอกสารและชุดเอกสารที่สร้างไว้ล่วงหน้าสำหรับเฟรมเวิร์ก Cocoa ส่วนใหญ่มีอยู่ที่:
เมื่อคุณมีชุดเอกสารแล้ว คุณอาจต้องการใช้กับเบราว์เซอร์เอกสารประกอบ:
มีปัญหา? นี่คือสิ่งที่คุณสามารถทำได้เพื่อแก้ไขปัญหา:
git pull และรันด้วยเวอร์ชันล่าสุดอีกครั้ง--verbose ระดับเริ่มต้นคือ 2 แต่คุณสามารถเพิ่มการใช้คำฟุ่มเฟือยแบบค่อยเป็นค่อยไปได้ถึง 6 โดยแต่ละระดับจะให้ข้อมูลโดยละเอียดมากขึ้น เนื่องจากจะทำให้คุณได้รับข้อมูลมากขึ้น คุณอาจต้องการเน้นไปที่ชุดไฟล์ต้นฉบับที่คุณมีปัญหาเท่านั้น โปรดทราบว่าการเพิ่มคำฟุ่มเฟือยจะส่งผลให้ประสิทธิภาพช้าลง ดังนั้นจึงไม่แนะนำให้ใช้ระดับที่สูงกว่า 4 สำหรับการใช้งานทุกวันหากคุณต้องการมีส่วนร่วม โปรดดูไฟล์หมายเหตุสำหรับนักพัฒนาเพื่อดูภาพรวมโดยย่อเกี่ยวกับวิธีการทำงานภายในของ appledoc
appledoc ได้รับใบอนุญาตพร้อมใบอนุญาต BSD ที่ได้รับการแก้ไข ในภาษาธรรมดา: คุณได้รับอนุญาตให้ทำทุกอย่างที่คุณต้องการด้วยโค้ด แก้ไข แจกจ่ายซ้ำ ฝังในผลิตภัณฑ์ของคุณ (ฟรีหรือเชิงพาณิชย์) แต่คุณต้องรวมลิขสิทธิ์ เงื่อนไขการใช้งาน และข้อจำกัดความรับผิดชอบตามที่ระบุไว้ในใบอนุญาตเหมือนกัน เช่นเดียวกับรหัสลิขสิทธิ์ BSD อื่น ๆ แน่นอนว่าคุณสามารถใช้เอกสารที่สร้างโดย appledoc สำหรับผลิตภัณฑ์ของคุณ (ฟรีหรือเชิงพาณิชย์) แต่คุณต้องระบุแหล่งที่มาของ appledoc ทั้งในเอกสารประกอบหรือในที่อื่นที่เหมาะสม เช่น เว็บไซต์ของคุณ
หากคุณไม่สามารถยอมรับข้อกำหนดเหล่านี้ได้ไม่ว่าด้วยเหตุผลใดก็ตาม โปรดติดต่อเราผ่านแบบฟอร์มติดต่อในหน้าเกี่ยวกับของเรา เราจะพยายามอย่างเต็มที่เพื่อช่วยเหลือคุณและค้นหาวิธีแก้ปัญหา!
ลิขสิทธิ์ (c) 2009-2011, Gentle Bytes สงวนลิขสิทธิ์
อนุญาตให้แจกจ่ายซ้ำและใช้ในแหล่งที่มา รูปแบบไบนารี และเอกสารที่สร้างขึ้น โดยมีหรือไม่มีการแก้ไข โดยต้องตรงตามเงื่อนไขต่อไปนี้:
การแจกจ่ายซอร์สโค้ดซ้ำต้องคงประกาศลิขสิทธิ์ข้างต้น รายการเงื่อนไขนี้ และข้อจำกัดความรับผิดชอบต่อไปนี้
การแจกจ่ายซ้ำในรูปแบบไบนารีจะต้องทำซ้ำประกาศลิขสิทธิ์ข้างต้น รายการเงื่อนไขนี้ และข้อจำกัดความรับผิดชอบต่อไปนี้ในเอกสารประกอบและ/หรือเอกสารอื่นๆ ที่ให้มาพร้อมกับการแจกจ่าย
การแจกจ่ายเอกสารที่สร้างโดย appledoc จะต้องระบุแหล่งที่มาของ appledoc ทั้งในเอกสารประกอบเองหรือในสื่ออื่นๆ ที่เหมาะสม
ห้ามใช้ชื่อของ appledoc, Gentle Bytes หรือชื่อผู้ร่วมให้ข้อมูลเพื่อรับรองหรือโปรโมตผลิตภัณฑ์ที่ได้จากซอฟต์แวร์นี้โดยไม่ได้รับอนุญาตเป็นลายลักษณ์อักษรล่วงหน้าเป็นการเฉพาะ
ซอฟต์แวร์นี้จัดทำโดยผู้ถือลิขสิทธิ์และผู้มีส่วนร่วม "ตามสภาพที่เป็นอยู่" และการรับประกันโดยชัดแจ้งหรือโดยนัยใดๆ ซึ่งรวมถึงแต่ไม่จำกัดเพียง การรับประกันโดยนัยต่อความสามารถเชิงพาณิชย์และความเหมาะสมสำหรับวัตถุประสงค์เฉพาะใดๆ จะถูกปฏิเสธ ไม่ว่าในกรณีใด ผู้ถือลิขสิทธิ์หรือผู้ร่วมให้ข้อมูลจะต้องรับผิดต่อความเสียหายโดยตรง โดยอ้อม โดยบังเอิญ พิเศษ ที่เป็นแบบอย่าง หรือเป็นผลสืบเนื่องใด ๆ (รวมถึงแต่ไม่จำกัดเฉพาะ การจัดหาสินค้าหรือบริการทดแทน การสูญเสียการใช้งาน ข้อมูล หรือผลกำไร; หรือธุรกิจ การหยุดชะงัก) ไม่ว่าจะเกิดขึ้นและตามทฤษฎีความรับผิดใดๆ ไม่ว่าในสัญญา ความรับผิดที่เข้มงวด หรือการละเมิด (รวมถึงความประมาทเลินเล่อหรืออย่างอื่น) ที่เกิดขึ้นในลักษณะใดก็ตามจากการใช้ซอฟต์แวร์นี้ แม้ว่าจะได้รับแจ้งถึงความเป็นไปได้ของความเสียหายดังกล่าวก็ตาม
อีเมลอ่อนโยน [email protected]
