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

ฉันสนุกกับการออกแบบภาษาโปรแกรม บางครั้งฉันคิดว่าโครงการภาษาของฉันและผู้ใช้ที่มีศักยภาพของพวกเขาจะได้รับประโยชน์จากเอกสารมาตรฐานที่ครอบคลุม ฉันดูที่มาตรฐานภาษาหลายภาษาตั้งแต่แบบเป็นทางการ (C ++) ไปจนถึงแบบไม่เป็นทางการ (ECMAScript) แต่ฉันไม่สามารถจัดการกับวิธีการที่ฉันควรแยกสิ่งต่าง ๆ และจัดระเบียบเอกสารดังกล่าวแม้ว่าฉันจะ คิดว่าฉันค่อนข้างดีในการเขียนเชิงเทคนิคโดยทั่วไป ฉันควรจะเขียนมันเหมือนแบบฝึกหัดที่มีความยาวหรือมากกว่าอย่างเช่นกระดาษคณิตศาสตร์อย่างเป็นทางการ? ฉันจะปรับปรุงให้ทันสมัยได้อย่างไรถ้าฉันพัฒนาไปพร้อมกับการใช้งานอ้างอิง ฉันควรเลิกและปฏิบัติตามการนำไปใช้และเอกสารเป็นมาตรฐานตามความเป็นจริงหรือไม่? นอกจากนี้จะมีประโยชน์ใด ๆ ที่สำคัญในการมีมาตรฐานหรือไม่? การกำหนดมาตรฐานหมายความว่าภาษานั้นซับซ้อนหรือไม่

16 programming-languages  documentation  standardization 

ฉันกำลังทำงานกับผลิตภัณฑ์สำหรับลูกค้าที่ต้องถูกต้องและเหมาะสมกับวัตถุประสงค์ มันสร้างขึ้นบนกอง LAMP (PHP / Cake) ดังนั้นจึงมี GPL, MIT, PHP, APACHE สิทธิ์การใช้งาน: "ตามสภาพ" โดยไม่มีการรับประกันหรือเงื่อนไขใด ๆ ไม่ว่าโดยชัดแจ้งหรือโดยนัยรวมถึง แต่ไม่ จำกัด เพียงการรับประกันหรือเงื่อนไขใด ๆ ของ TITLE การไม่ละเมิดสิทธิมนุษยชนหรือความเหมาะสมสำหรับวัตถุประสงค์เฉพาะ คุณเป็นผู้รับผิดชอบ แต่เพียงผู้เดียวในการพิจารณาความเหมาะสมในการใช้หรือแจกจ่ายงานและความเสี่ยงที่เกี่ยวข้องกับการใช้สิทธิ์ของคุณภายใต้ใบอนุญาตนี้ เหตุผลของฉันที่ผลิตภัณฑ์ของฉันถูกต้องและเหมาะสมกับวัตถุประสงค์: เอกสาร UAT ที่ลงนามแล้วนั้นพิสูจน์ความถูกต้องและความเหมาะสมสำหรับวัตถุประสงค์ สแต็คมีการใช้อย่างกว้างขวางโดยนักพัฒนาอุตสาหกรรมและผู้ใช้ (netcraft, gartner ฯลฯ สถิติ) ว่ามีฉันทามติว่ามันเหมาะสำหรับวัตถุประสงค์ (เช่นเราสามารถเพิกเฉยต่อความเหมาะสมของข้อความเพื่อวัตถุประสงค์ในการปฏิเสธความรับผิดชอบตามขอบเขตการรับประกัน) นี่เป็นจุดที่ถูกต้องหรือไม่? ฉันสามารถทำการอ้างสิทธิ์ได้ว่าซอฟต์แวร์ของฉันนั้นเหมาะสมกับวัตถุประสงค์หรือไม่

15 licensing  documentation  specifications 

ปัจจุบันฉันทำงานร่วมกับอาจารย์ที่มหาวิทยาลัยของฉันเพื่อพัฒนาหลักสูตรใหม่สำหรับหลักสูตรวิศวกรรมซอฟต์แวร์และการออกแบบ Capstone ที่เปิดสอนในวิทยาลัยของฉัน จนกระทั่งเมื่อไม่นานมานี้ทั้งสองหลักสูตรใช้โมเดลน้ำตกโดยเฉพาะและทำให้นักเรียนใช้เวลาส่วนใหญ่ในการเขียนรายงานยาว ๆ หลังจากแรงกดดันจากฉันมากอาจารย์ของฉันตัดสินใจที่จะรวม Scrum ในหลักสูตรวิศวกรรมซอฟต์แวร์ภาคการศึกษาที่ผ่านมานี้ ครึ่งแรกของภาคการศึกษายังคงเป็นน้ำตกมีนักเรียนเขียนรายงานการออกแบบ 40 หน้าและเอกสารข้อกำหนดซอฟต์แวร์ กลางภาคเรียนทุกทีมจะต้องปล่อยตัวอย่างของแอปพลิเคชัน เมื่อถึงจุดนั้นเส้นทางก็เปลี่ยนไปเป็น Scrum พร้อมกับการวิ่ง 3 สัปดาห์สองครั้ง ตอนนี้เรากำลังพยายามหาวิธีกำจัดน้ำตกทั้งหมดและสร้างหลักสูตรที่ใช้การแย่งชิงกันโดยเฉพาะ น่าเสียดายที่เราพบความไม่ลงรอยกันระหว่าง Scrum และนักเรียน: การประชุมการต่อสู้รายวันแทบเป็นไปไม่ได้สำหรับนักเรียน แม้ในระหว่างชั้นเรียนมันไม่สะดวกสำหรับนักเรียนที่จะจัดการประชุม Scrum เนื่องจากอาจารย์มักจะบรรยาย การประมาณคะแนน / ชั่วโมงนั้นยากเนื่องจากนักเรียนไม่มีประสบการณ์ดังนั้นจึงไม่สามารถทำนายได้อย่างแม่นยำว่าจะต้องใช้เวลานานแค่ไหน การต่อสู้ทำงานได้ดีที่สุดกับนักพัฒนาแบบเต็มเวลาที่ทำงานร่วมกัน แต่นักเรียนไม่ใช่ ส่วนใหญ่นักเรียนใช้เวลา 15-20 ชั่วโมงต่อสัปดาห์ในการจัดหลักสูตรและการจัดงานประชุมอาจเป็นเรื่องยากมาก ทีมสามารถมีนักเรียนได้มากถึง 10 คน (และจะมีคนขี้เกียจหนึ่งหรือสองคน) อาจารย์ต้องการเอกสาร! ฉันไม่เคยได้ยินรายงานการแย่งชิงใด ๆ - เพียงแบ็คล็อกและชาร์ตการเผาไหม้ (ซึ่งฉันไม่แน่ใจว่าจะเพียงพอที่จะเอาใจนักวิชาการ) นักเรียนมักคิดว่าเปรียวหมายถึง "กระโดดเข้าและเริ่มเขียนโค้ดโดยไม่หันกลับมามอง" สิ่งนี้นำไปสู่โค้ดที่น่ากลัวที่สุดที่จินตนาการได้ ดังนั้นฉันกำลังมองหาวิธีในการบังคับใช้การออกแบบที่เหมาะสมโดยไม่ต้องใช้เอกสาร 50 หน้าหรือกองของไดอะแกรม UML …

15 agile  scrum  documentation 

ปิด. คำถามนี้เป็นคำถามปิดหัวข้อ ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้เป็นหัวข้อสำหรับ Software Engineering Stack Exchange ปิดให้บริการใน6 ปีที่ผ่านมา ฉันกำลังมองหาซอฟต์แวร์เพื่อจัดระเบียบและดูแลรักษาเอกสารภายในโครงการข้อมูลจำเพาะข้อกำหนด ฯลฯ ขณะนี้เราจัดเก็บเอกสารทั้งหมดเป็นไฟล์ MS Word DOC จำนวนมากในแหล่งเก็บข้อมูลการควบคุมแหล่งที่มาซึ่งทำให้เราสามารถควบคุมเวอร์ชันได้ แต่คุณไม่สามารถค้นหาข้อมูลนี้สร้างลิงค์ระหว่างพวกเขาจัดหมวดหมู่ทำงานร่วมกัน ข้อกำหนดการตั้งค่า: การติดตั้งเป็นศูนย์บนฝั่งไคลเอ็นต์ (อิงจากเว็บ) การควบคุมเวอร์ชันของเอกสาร คำอธิบายประกอบเอกสาร การเชื่อมโยงเอกสาร การค้นหาแบบเต็ม (เอกสารทั้งหมด) MS Word (* .doc) import \ export โปรแกรมแก้ไขข้อความ WYSIWYG ระบบที่ฉันค้นพบและทดลองใช้: มีเดียวิกิ XWiki ที่บรรจบกัน

15 project-management  documentation  knowledge-management  knowledge-base 

หาก JSON ย่อมาจากสัญกรณ์วัตถุ JavaScript แล้วเมื่อคุณพูดว่าวัตถุ JSON คุณไม่ได้พูดว่า "วัตถุจาวาสคริปต์วัตถุสัญลักษณ์" หรือไม่? จะพูดว่า "สตริง JSON" ถูกต้องหรือไม่ หรือว่าจะพูดให้ถูกต้องมากขึ้น (เช่นเดียวกับใน "บริการทั้งสองนี้ส่งต่อ JSON ระหว่างกัน")

15 documentation  grammar  json 

ฉันมีคำถามสองสามข้อเกี่ยวกับการเขียนข้อกำหนดและพวกเขาคือ: เมื่อเราเขียนข้อกำหนดซอฟต์แวร์ภายใต้หัวข้อ "ข้อกำหนดของผู้ใช้ข้อกำหนด" เราต้องระบุ "ฟังก์ชั่น" และ "ข้อ จำกัด " เท่านั้นหรือไม่ "ส่วนต่อประสานผู้ใช้" ตกลงไปใน "ฟังก์ชั่น" หรือ "ข้อ จำกัด " หรือไม่? พื้นที่สำคัญที่สำคัญ (ข้อกำหนด) คืออะไรซอฟต์แวร์สามารถแบ่งออกเป็น (เช่น UI)?

15 documentation  requirements 

มีเอกสารด้านเทคนิค (สำหรับนักพัฒนาในอนาคต) เพียงพอหรือไม่ มีอัตราส่วนระหว่างการเข้ารหัสชั่วโมงและการบันทึกเวลาที่เหมาะสมหรือไม่? Papadimoulis โต้แย้งว่าคุณควร ผลิตเอกสารจำนวนน้อยที่สุดที่จำเป็นเพื่ออำนวยความสะดวกในการทำความเข้าใจมากที่สุด นั่นเป็นแนวทางที่ดีหรือมีสิ่งเฉพาะที่ฉันควรสร้างหรือไม่?

15 documentation 

ฉันทำงานใน บริษัท ระบบควบคุมซึ่งงานหลักคือSCADAและPLCพร้อมกับระบบควบคุมอื่น ๆ การพัฒนาซอฟต์แวร์ไม่ใช่สิ่งที่ บริษัท ทำจริงๆนอกเหนือจากที่นี่และที่นั่นจนกระทั่งมีการตัดสินใจที่จะสร้างการจัดการโครงการภายในและระบบการประเมินผล โครงการนี้ดำเนินการโดยผู้ที่มาที่นี่ในฐานะผู้ใช้ซอฟต์แวร์ แต่เดิมและเราส่วนใหญ่เป็นผู้น้อย โครงการเริ่มจากเล็กดังนั้นเราจึงบันทึกเฉพาะสิ่งต่าง ๆ เช่นการออกแบบสิ่งฐานข้อมูลเป็นต้น แต่เราไม่เคยเห็นด้วยกับรูปแบบการเข้ารหัส / อนุสัญญา เราเริ่มใช้StyleCopเพื่อให้แน่ใจว่าเรามีรหัสที่ดี แต่ฉันรู้สึกว่าเราจำเป็นต้องมีเอกสารอย่างเป็นทางการสำหรับการเข้ารหัสอนุสัญญา / การปฏิบัติเพื่อให้เราสามารถดำเนินการต่อในมาตรฐานที่ดีและหากมีงานพัฒนาที่สำคัญอีกต่อไปในอนาคต มีแผ่นฐานที่ดี ปัญหานั้นอยู่ที่ฉันไม่ทราบวิธีการร่างเอกสารสำหรับการเข้ารหัสการประชุมและมาตรฐานทั้งหมดที่ฉันคิดว่าเป็นตัวอย่างของการปฏิบัติที่ดีและไม่ดี (ตัวอย่างเช่นกรณีอูฐเมื่อตั้งชื่อตัวแปรหลีกเลี่ยงสัญกรณ์ฮังการี ฯลฯ ) เราทุกคน โปรแกรมเมอร์ที่เก่งพอสมควร (ชัด) แต่เราก็ไม่มีกฎบัตรสำหรับเนื้อหาประเภทนี้ คำถามของฉันคืออะไรประเด็นสำคัญและเนื้อหาของเอกสารมาตรฐานการเข้ารหัสที่ดีมีอะไรบ้าง

15 programming-practices  documentation  coding-standards  standardization 

ฉันกำลังมองหารูปแบบเอกสารข้อมูลระดับสำหรับ Entity, Business Logic และคลาส Data Access ของฉัน ฉันพบรูปแบบสองรูปแบบจากที่นี่ รูปแบบ 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// Revision History: /// Name: Date: Description: ///----------------------------------------------------------------- รูปแบบ 2 // =============================== // AUTHOR : // CREATE DATE : …

15 c#  documentation  comments 

บริษัท ของเรากำลังอยู่ในขั้นตอนการแปลงกระบวนการทางธุรกิจจำนวนมาก (และความรู้เชิงสถาบันที่เกี่ยวข้อง) เป็นซอฟต์แวร์องค์กรใหม่ โครงการกำลังดำเนินไปได้ดี แต่เมื่อเราดำเนินการต่อไปก็ชัดเจนว่ามีความสับสนมากมายเกี่ยวกับคำศัพท์และคำจำกัดความทั้งในด้านธุรกิจและการพัฒนา ฉันได้รับทราบถึงข้อโต้แย้งของอีวานในการสร้างภาษาที่แพร่หลายอยู่พักหนึ่ง แต่นี่เป็นครั้งแรกที่ฉันต้องการบันทึกเอกสารอย่างเป็นทางการ เมื่อฉันมองไปรอบ ๆ และลองนึกถึงสถานที่ / วิธีการจัดทำเอกสารคำศัพท์ UL ของเราฉันก็หลงทาง บริษัท อื่นทำเอกสารภาษาที่ใช้กันแพร่หลายอย่างไร นี่เป็นเพียงพจนานุกรมวิกิหรือไม่ มีเครื่องมือบางอย่างสำหรับจุดประสงค์นี้หรือไม่?

14 documentation  domain-driven-design 

เมื่อเร็ว ๆ นี้ฉันได้พบว่าวัตถุที่เปลี่ยนไม่ได้มีประโยชน์อย่างไรและเช่นถ้าคุณส่งองค์ประกอบไปยังตัวสร้างและคลาสของคุณควรจะไม่เปลี่ยนรูปคุณต้องคัดลอกองค์ประกอบเหล่านี้หากพวกเขาไม่เปลี่ยนรูปตัวเอง สิ่งนี้ต้องการการตรวจสอบหรือความรู้มากมายเกี่ยวกับโครงการของฉันเพราะถ้าฉันมี public A(B foo) และBไม่ได้เปลี่ยนรูปฉันต้องคัดลอกA Bตอนนี้จินตนาการBดูเหมือนไม่เปลี่ยนรูป แต่ตัวเองมีคลาสที่ไม่แน่นอนในตัวสร้างและอื่น ๆ มีมาตรฐานหรือแนวปฏิบัติที่ดีที่สุดสำหรับการจัดทำเอกสารหรือไม่หากคลาสไม่เปลี่ยนรูปแบบใน Java? ดูเหมือนว่าไม่มี@immutableคำหลักใน Javadoc คำอธิบายประกอบ @Immutableดูเหมือนว่าจะมีบางสิ่งบางอย่างที่แตกต่างกันโดยสิ้นเชิงในการผลิตระดับอัตโนมัติและไม่ได้เป็นส่วนหนึ่งของมาตรฐาน Java

14 java  documentation  immutability 

ปิด คำถามนี้เป็นคำถามความคิดเห็นตาม ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบข้อเท็จจริงและการอ้างอิงได้โดยแก้ไขโพสต์นี้ ปิดให้บริการใน4 ปีที่แล้ว ฉันกำลังเรียน Python ซึ่งไม่ได้เป็นส่วนหนึ่งของหลักสูตรวิทยาลัยของฉัน ฉันถูกถามในการสัมภาษณ์ว่าทำไมฉันถึงเลือก Python และฉันตอบว่ามันง่ายต่อการเรียนรู้และเอกสารนั้นเขียนได้ดีมาก ผู้สัมภาษณ์ไม่ตอบว่าเป็นเหตุผลที่ดีหรือไม่ เขาดูมั่นใจ แต่ฉันไม่แน่ใจ เอกสารที่เขียนเป็นอย่างดีพร้อมกับความสะดวกในการเรียนรู้เหตุผลที่ดีพอสำหรับการเลือกภาษาสคริปต์หรือไม่? หรือฉันควรอธิบายเพิ่มเติมเกี่ยวกับความพร้อมใช้งานของไลบรารี Python และฐานผู้ใช้ที่ใหญ่ขึ้นของ Python เพียงแค่ทราบ Python ไม่จำเป็นสำหรับงาน บริษัท ทำงานกับ Ruby-on-rails Python อยู่ในประวัติย่อของฉันและฉันคิดว่าผู้สัมภาษณ์ต้องการทราบถึงข้อควรพิจารณาที่ฉันทำขึ้นใหม่ในขณะที่เลือกภาษาการเขียนโปรแกรม

14 learning  python  interview  documentation 

ปิด คำถามนี้จะต้องมีมากขึ้นมุ่งเน้น ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้มุ่งเน้นที่ปัญหาเดียวโดยแก้ไขโพสต์นี้ ปิดให้บริการใน4 ปีที่แล้ว ในทำนองเดียวกันโครงการโอเพ่นซอร์สจะประสบความสำเร็จได้อย่างไรหากไม่มีเอกสารเกี่ยวกับการออกแบบหรือสถาปัตยกรรม? คำถามฉันอยากรู้อยากเห็น: ทำไมห้องสมุดจำนวนมากจึงขาดเอกสารคู่มือผู้ใช้? มุมมองของฉันคือ: ทุกคนส่วนใหญ่ยอมรับว่าการอ่านซอร์สโค้ดนั้นยากกว่าการเขียนซอร์สโค้ด หากไม่มีเอกสารเราจะต้องอ่านซอร์สโค้ดของไลบรารีเพื่อใช้ไลบรารีนั้น ดังนั้นการใช้ไลบรารี่ที่ไม่มีเอกสารจะทำงานได้ดีกว่าการสร้างไลบรารี่ขึ้นใหม่จากศูนย์ ด้วยเหตุนี้หากคุณต้องการให้คนอื่นใช้ห้องสมุดของคุณคุณควรจะมีเอกสารที่ดีกว่า ฉันรู้ว่านักพัฒนาจำนวนมากไม่ชอบเขียนเอกสารและฉันยอมรับว่ามันอาจเป็นงานที่น่าเบื่อ แต่มันเป็นงานที่สำคัญ ฉันยังบอกด้วยว่ามันสำคัญกว่าที่ห้องสมุดมีเอกสารที่ดีกว่ามีส่วนต่อประสานโปรแกรมเมอร์ที่ดีที่สุดในโลก (ผู้คนใช้ไลบรารีที่ไม่เหมาะสมอยู่ตลอดเวลามีผู้ใช้เพียงไม่กี่คนที่ไม่มีเอกสาร) โอ้โปรดทราบว่าเมื่อฉันพูดเอกสารฉันหมายถึงเอกสารจริง ไม่ใช่ Sandcastle / Javadoc / Doxygen boilerplate

14 documentation 

เรากำลังรวมกระบวนการทดสอบในกระบวนการ SCRUM ของเรา บทบาทใหม่ของฉันคือการเขียนการทดสอบการยอมรับของเว็บแอปพลิเคชันของเราเพื่อทำการทดสอบในภายหลังโดยอัตโนมัติ ฉันได้อ่านมากมายเกี่ยวกับวิธีการเขียนกรณีทดสอบ แต่ไม่มีใครให้คำแนะนำเชิงปฏิบัติแก่ฉันในการเขียนกรณีทดสอบสำหรับเว็บแอปพลิเคชันที่ซับซ้อนและแทนที่จะใช้หลักการที่ขัดแย้งกันซึ่งฉันพบว่าใช้ยาก: กรณีทดสอบควรสั้น:นำตัวอย่างของ CMS กรณีทดสอบสั้น ๆ นั้นง่ายต่อการบำรุงรักษาและเพื่อระบุอินพุตและเอาต์พุต แต่ถ้าฉันต้องการทดสอบชุดการทำงานที่ยาวนาน (เช่นการเพิ่มเอกสารการส่งการแจ้งเตือนไปยังผู้ใช้รายอื่นผู้ใช้รายอื่นตอบกลับเอกสารการเปลี่ยนแปลงสถานะผู้ใช้จะได้รับการแจ้งเตือน) สำหรับฉันแล้วดูเหมือนว่ากรณีทดสอบควรแสดงถึงสถานการณ์ที่สมบูรณ์ แต่ฉันสามารถดูว่าสิ่งนี้จะผลิตเอกสารทดสอบที่ซับซ้อนมากเกินไป การทดสอบควรระบุอินพุตและเอาต์พุต::จะเป็นอย่างไรถ้าฉันมีรูปแบบยาวที่มีฟิลด์โต้ตอบจำนวนมากที่มีพฤติกรรมแตกต่างกัน ฉันจะเขียนหนึ่งการทดสอบสำหรับทุกสิ่งหรือไม่หรือสำหรับแต่ละการทดสอบ? กรณีทดสอบควรมีความเป็นอิสระ:แต่ฉันจะใช้สิ่งนั้นได้อย่างไรหากการทดสอบการดำเนินการอัปโหลดต้องการให้การเชื่อมต่อสำเร็จ และใช้กับการเขียนกรณีทดสอบได้อย่างไร ฉันควรจะเขียนการทดสอบสำหรับแต่ละการดำเนินการ แต่การทดสอบแต่ละครั้งจะประกาศการขึ้นต่อกันหรือฉันควรจะเขียนสถานการณ์ทั้งหมดสำหรับการทดสอบแต่ละครั้งอีกครั้ง? กรณีทดสอบควรจัดทำเป็นเอกสารเล็กน้อย:หลักการนี้เฉพาะกับโครงการ Agile ดังนั้นคุณมีคำแนะนำเกี่ยวกับวิธีการใช้หลักการนี้หรือไม่? แม้ว่าฉันคิดว่าการเขียนแบบทดสอบตอบรับจะเป็นเรื่องง่าย แต่ฉันก็พบว่าตัวเองตัดสินใจทุกอย่างที่ต้องทำ (FYI: ฉันเป็นนักพัฒนาและไม่ใช่ผู้ทดสอบมืออาชีพ) ดังนั้นคำถามหลักของฉันคือ: คุณมีขั้นตอนหรือคำแนะนำอะไรบ้างในการเขียนเคสทดสอบการยอมรับที่ยอมรับได้สำหรับการใช้งานที่ซับซ้อน ขอขอบคุณ. แก้ไข : เพื่อชี้แจงคำถามของฉัน: ฉันทราบว่าการทดสอบการยอมรับควรเริ่มจากข้อกำหนดและพิจารณาว่าแอปพลิเคชันทั้งหมดเป็นกล่องดำ คำถามของฉันเกี่ยวข้องกับขั้นตอนการปฏิบัติในการเขียนเอกสารทดสอบระบุกรณีทดสอบจัดการกับการอ้างอิงระหว่างการทดสอบ ... สำหรับเว็บแอปพลิเคชันที่ซับซ้อน

14 testing  documentation  acceptance-testing 

ขณะนี้ฉันใช้สองระบบเพื่อเขียนเอกสารรหัส (กำลังใช้ C ++): เอกสารเกี่ยวกับวิธีการและสมาชิกคลาสจะถูกเพิ่มถัดจากรหัสโดยใช้รูปแบบ Doxygen บนเซิร์ฟเวอร์ Doxygen ทำงานบนแหล่งข้อมูลเพื่อให้สามารถเห็นผลลัพธ์ในเว็บเบราว์เซอร์ หน้าภาพรวม (อธิบายชุดของคลาสโครงสร้างของแอปพลิเคชันรหัสตัวอย่าง ... ) จะถูกเพิ่มไปยังวิกิ ฉันคิดว่าวิธีนี้ง่ายมากเพราะเอกสารเกี่ยวกับสมาชิกและคลาสนั้นใกล้เคียงกับโค้ดจริง ๆ ในขณะที่หน้าภาพรวมนั้นง่ายต่อการแก้ไขใน Wiki (และยังง่ายต่อการเพิ่มรูปภาพตาราง ... ) เว็บเบราว์เซอร์ช่วยให้คุณดูเอกสารทั้งสอง ตอนนี้เพื่อนร่วมงานของฉันแนะนำให้ใส่ทุกอย่างใน Doxygen เพราะเราสามารถสร้างไฟล์ช่วยเหลือขนาดใหญ่หนึ่งไฟล์พร้อมทุกสิ่งในนั้น (โดยใช้ HTML WorkShop หรือ Qt Assistant ของ Microsoft) ความกังวลของฉันคือการแก้ไขเอกสารสไตล์ Doxygen นั้นยากกว่ามาก (เมื่อเทียบกับ Wiki) โดยเฉพาะเมื่อคุณต้องการเพิ่มตารางรูปภาพ ... (หรือมีเครื่องมือ 'ดูตัวอย่าง' สำหรับ Doxygen ที่ไม่ต้องการให้คุณสร้าง รหัสก่อนที่คุณจะเห็นผลลัพธ์ได้หรือไม่) โครงการโอเพ่นซอร์สขนาดใหญ่ (หรือซอร์สปิด) อะไรที่ใช้ในการเขียนเอกสารรหัส? พวกเขายังแยกสิ่งนี้ระหว่าง …

13 documentation  documentation-generation  wiki