คำถามติดแท็ก doxygen

ปิด. คำถามนี้ไม่เป็นไปตามหลักเกณฑ์กองมากเกิน ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้เป็นไปตามหัวข้อสำหรับ Stack Overflow ปิดให้บริการใน2 ปีที่ผ่านมา ปรับปรุงคำถามนี้ หนึ่งในฟีเจอร์ใหม่ของXcode 5คือความสามารถในการจัดทำเอกสารโค้ดของคุณเองด้วยไวยากรณ์ความคิดเห็นพิเศษ รูปแบบคล้ายกับ doxygen แต่ดูเหมือนจะรองรับชุดย่อยของคุณลักษณะเหล่านั้นเท่านั้น สนับสนุนคำสั่งใดและคำสั่งใดไม่ ประเพณีของพวกเขาแตกต่างจาก Doxygen หรือไม่?

186 objective-c  documentation  comments  doxygen  xcode5 

ฉันยังใหม่กับการเขียนโปรแกรมโดยทั่วไปดังนั้นฉันจึงตัดสินใจว่าจะเริ่มต้นด้วยการสร้างคลาสเวกเตอร์อย่างง่ายใน C ++ อย่างไรก็ตามฉันต้องการสร้างนิสัยที่ดีตั้งแต่เริ่มต้นแทนที่จะพยายามแก้ไขขั้นตอนการทำงานของฉันในภายหลัง ขณะนี้ฉันมีเพียงสองไฟล์vector3.hppและvector3.cpp. โครงการนี้จะเริ่มเติบโตอย่างช้าๆ (ทำให้เป็นไลบรารีพีชคณิตเชิงเส้นทั่วไปมากขึ้น) เมื่อฉันคุ้นเคยกับทุกสิ่งมากขึ้นฉันจึงต้องการใช้เค้าโครงโครงการ "มาตรฐาน" เพื่อทำให้ชีวิตง่ายขึ้นในภายหลัง หลังจากมองไปรอบ ๆ ฉันได้พบสองวิธีในการจัดระเบียบไฟล์ hpp และ cpp วิธีแรก: project └── src ├── vector3.hpp └── vector3.cpp และสิ่งที่สอง: project ├── inc │ └── project │ └── vector3.hpp └── src └── vector3.cpp คุณจะแนะนำตัวไหนและเพราะอะไร ประการที่สองฉันต้องการใช้ Google C ++ Testing Framework สำหรับการทดสอบหน่วยของฉันเนื่องจากดูเหมือนว่าจะใช้งานง่าย คุณแนะนำให้รวมสิ่งนี้เข้ากับรหัสของฉันเช่นในinc/gtestหรือcontrib/gtestโฟลเดอร์หรือไม่ หากรวมกลุ่มคุณแนะนำให้ใช้fuse_gtest_files.pyสคริปต์เพื่อลดจำนวนหรือไฟล์หรือปล่อยให้เป็น หากไม่ได้รวมการพึ่งพานี้จะจัดการอย่างไร เมื่อพูดถึงการทดสอบการเขียนโดยทั่วไปมีการจัดระเบียบอย่างไร? …

123 c++  cmake  doxygen  googletest 

ฉันทำเอกสารสำหรับ SDK ของฉันโดยใช้ Doxygen มันมีรายการไฟล์เนมสเปซคลาสประเภท ฯลฯ - ทุกอย่างที่ฉันวางไว้เป็นความคิดเห็นของ Doxygen ในโค้ด ตอนนี้ฉันต้องการเขียนข้อมูลทั่วไปเกี่ยวกับ SDK (ชนิดของบทนำ) ซึ่งไม่เกี่ยวข้องโดยตรงกับองค์ประกอบโค้ดใด ๆ ฉันต้องการวางบทนำนี้ในหน้าเริ่มต้นของเอกสาร ฉันจะทำเช่นนี้ได้อย่างไร?

103 doxygen 

ปิด . คำถามนี้เป็นคำถามความคิดเห็นตาม ขณะนี้ยังไม่ยอมรับคำตอบ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบได้ด้วยข้อเท็จจริงและการอ้างอิงโดยแก้ไขโพสต์นี้ ปิดให้บริการใน2 ปีที่ผ่านมา ปรับปรุงคำถามนี้ สามัญสำนึกบอกว่าบล็อกข้อคิดเห็นของ Doxygen ต้องใส่ไว้ในไฟล์ส่วนหัวที่มีคลาสโครงสร้าง enums ฟังก์ชันการประกาศอยู่ ฉันยอมรับว่านี่เป็นข้อโต้แย้งที่ดีสำหรับไลบรารีที่ตั้งใจจะแจกจ่ายโดยไม่มีซอร์ส (เฉพาะส่วนหัวและไลบรารีที่มีรหัสออบเจ็กต์) แต่ ... ฉันเคยคิดถึงวิธีที่ตรงกันข้ามเมื่อฉันพัฒนาไลบรารีภายในของ บริษัท (หรือเป็นโครงการด้านข้างสำหรับตัวฉันเอง) ซึ่งจะใช้กับซอร์สโค้ดแบบเต็ม สิ่งที่ฉันเสนอคือใส่บล็อกความคิดเห็นขนาดใหญ่ในไฟล์การใช้งาน (HPP, INL, CPP ฯลฯ ) เพื่อไม่ให้เกะกะอินเทอร์เฟซของคลาสและฟังก์ชันที่ประกาศในส่วนหัว ข้อดี: ความยุ่งเหยิงน้อยลงในไฟล์ส่วนหัวสามารถเพิ่มได้เฉพาะการจัดหมวดหมู่ของฟังก์ชันเท่านั้น บล็อกความคิดเห็นที่แสดงตัวอย่างเมื่อใช้ Intellisense ไม่ได้ปะทะกัน - นี่เป็นข้อบกพร่องที่ฉันสังเกตเห็นเมื่อฉันมีบล็อกความคิดเห็นสำหรับฟังก์ชันในไฟล์. H และมีคำจำกัดความแบบอินไลน์ในไฟล์. H เดียวกัน แต่รวมจากไฟล์. INL จุดด้อย: (สิ่งที่ชัดเจน) บล็อกความคิดเห็นไม่ได้อยู่ในไฟล์ส่วนหัวที่มีการประกาศ คุณคิดว่าอย่างไรและอาจแนะนำ?

100 documentation  comments  doxygen 

ปิด . คำถามนี้จะต้องมีมากขึ้นมุ่งเน้น ขณะนี้ยังไม่ยอมรับคำตอบ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้เน้นไปที่ปัญหาเดียวโดยแก้ไขโพสต์นี้เท่านั้น ปิดให้บริการใน2 ปีที่ผ่านมา ปรับปรุงคำถามนี้ ฉันชอบ Doxygen ในการสร้างเอกสารของรหัส C หรือ PHP ฉันมีโครงการ Python ที่กำลังจะมาถึงและฉันคิดว่าฉันจำได้ว่า Python ไม่มี/* .. */ความคิดเห็นและยังมีสิ่งอำนวยความสะดวกในการจัดทำเอกสารด้วยตนเองซึ่งดูเหมือนจะเป็นวิธีการจัดทำเอกสารแบบไพ ธ อน เนื่องจากฉันคุ้นเคยกับ Doxygen ฉันจะใช้มันเพื่อสร้างเอกสาร Python ได้อย่างไร มีอะไรเป็นพิเศษที่ฉันต้องระวังหรือไม่?

94 python  documentation  python-sphinx  doxygen  docstring 

ฉันค้นหาเนื้อหาบางอย่างที่อธิบายวิธีการสร้างไดอะแกรมคลาสง่ายๆด้วย doxygen แต่ไม่พบ ใครสามารถช่วย? ฉันต้องการสร้างไดอะแกรมดังที่แสดงด้านล่างจากชุดไฟล์ C ++ หากมีเครื่องมือที่ดีกว่าเพื่อให้ทำได้ง่ายขึ้นโปรดแจ้งให้เราทราบ

94 c++  uml  doxygen  graphviz  class-diagram 

ปิด . คำถามนี้เป็นคำถามความคิดเห็นตาม ขณะนี้ยังไม่ยอมรับคำตอบ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบพร้อมข้อเท็จจริงและการอ้างอิงได้โดยแก้ไขโพสต์นี้ ปิดให้บริการใน2 ปีที่ผ่านมา ปรับปรุงคำถามนี้ ฉันมีRแพ็คเกจที่ใช้roxygen2. มีCรหัสอยู่/srcและฉันเพิ่งเริ่มทำงานกับ Doxygen มีวิธีใดบ้างในการรวมเอกสารหรือรวมการคอมไพล์กับ roxygen2? "แนวทางปฏิบัติที่ดีที่สุด" สำหรับวางCเอกสารโค้ดไว้ที่ใด Googling สำหรับ roxygen2 และ doxygen ส่วนใหญ่นำไปสู่roxygen คล้ายกับผลลัพธ์ของdoxygen ฉันพบสองสามแพ็คเกจกับ Doxyfiles แต่ไม่มีองค์กรที่สอดคล้องกัน ตัวอย่างเช่น lme4 มีinst/doc/Doxyfileเอาต์พุตไปยังโฟลเดอร์ที่เรียกว่าdoxygenภายนอกlme4ไดเร็กทอรีต้นทาง นอกจากนี้ยังมี Doxyfile ในไดเร็กทอรีรากของ Matrix (แต่ในรีลีสก่อนหน้านี้อยู่ในinstเอกสารนี้จะถูกส่งออกนอกไดเร็กทอรีแพ็กเกจด้วย มีเหตุผลที่จะไม่รวมถึงการใด ๆCเอกสารภายในแพคเกจหรือทำไม Doxygen ใช้เพื่อบ่อยภายในแพคเกจ R แม้จะมีการใช้อย่างแพร่หลายของC? อัปเดต:ดูคำขอคุณลักษณะ roxygen2ที่เกี่ยวข้อง

91 c  r  documentation  doxygen  roxygen2