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

ฉันกำลังพยายามสืบทอดคลาสใน Python ฉันต้องการให้แต่ละคลาสและคลาสที่สืบทอดมามี docstrings ที่ดี ดังนั้นฉันคิดว่าสำหรับคลาสที่สืบทอดฉันต้องการที่จะ: สืบทอด docstring คลาสพื้นฐาน อาจแนบเอกสารเพิ่มเติมที่เกี่ยวข้องเข้ากับ docstring มีวิธีใด (ที่อาจสง่างามหรือไพโธนิก) ในการจัดการกับ docstring ประเภทนี้ในสถานการณ์การสืบทอดคลาสหรือไม่? แล้วการสืบทอดหลาย ๆ อย่างล่ะ?

101 python  inheritance  documentation 

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

100 documentation  comments  doxygen 

การใช้ JavaDoc ฉันจะอ้างอิงค่าของฟิลด์คงที่สุดท้ายในคลาสได้อย่างไร ฉันต้องการในตัวอย่างนี้ถูกแทนที่ด้วยค่าของสนาม???STATIC_FIELD /** * This is a simple class with only one static field with the value ???. */ public class Simple { /** * We can reference the value with {@value} here, * but how do we reference it in the class JavaDoc? */ public static final …

100 java  documentation  javadoc 

ปิด . คำถามนี้เป็นคำถามความคิดเห็นตาม ขณะนี้ยังไม่ยอมรับคำตอบ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบได้ด้วยข้อเท็จจริงและการอ้างอิงโดยแก้ไขโพสต์นี้นี้ ปิดให้บริการใน2 ปีที่ผ่านมา ปรับปรุงคำถามนี้ มีวิธีอัตโนมัติในการซิงค์ความคิดเห็นระหว่างอินเทอร์เฟซและการใช้งานหรือไม่ ฉันกำลังจัดทำเอกสารทั้งคู่และไม่ต้องการให้ซิงค์ด้วยตนเอง อัพเดท: พิจารณารหัสนี้: interface IFoo{ /// <summary> /// Commenting DoThis method /// </summary> void DoThis(); } class Foo : IFoo { public void DoThis(); } เมื่อฉันสร้างชั้นเรียนเช่นนี้: IFoo foo=new Foo(); foo.DoThis();//comments are shown in intellisense ความคิดเห็นที่นี่จะไม่แสดง: Foo foo=new Foo(); foo.DoThis();//comments are …

98 c#  documentation  xml-documentation 

ปิด. คำถามนี้ไม่เป็นไปตามหลักเกณฑ์กองมากเกิน ขณะนี้ยังไม่ยอมรับคำตอบ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้เป็นหัวข้อสำหรับ Stack Overflow ปิดให้บริการใน4 ปีที่แล้ว ปรับปรุงคำถามนี้ อัปเดตเมื่อสิงหาคม 2558: Pinterest แสดงที่นี่ตอนนี้https://dev.pinterest.com/ มีเอกสารอย่างเป็นทางการหรือไม่เป็นทางการเกี่ยวกับ v2 Pinterest API หรือไม่ สิ่งที่ฉันรู้: JSON api อยู่ในเวอร์ชัน 2 https://api.pinterest.com/v2ให้คุณตอบสนอง json ผู้คนกำลังเขียนโปรแกรมต่อต้านเนื่องจากมีแอปบนอุปกรณ์เคลื่อนที่และเวอร์ชันเบต้า คำถามการพิสูจน์ตัวตน Pintrest บน SO PHP wrapper สำหรับ v1 พร้อมการอัปเดตสำหรับ v2 บน Github โดย Kellanด้วยวิธีการ: อัปโหลดพิน repin บอร์ดกิจกรรมยอดนิยม - การอ่านโค้ดของ Kellan เป็นข้อมูลที่ดีที่สุดที่ฉันหาได้ ข้อมูลเพิ่มเติมเกี่ยวกับงานของ Kellan …

96 json  api  mobile  documentation  pinterest 

ปิด. คำถามนี้ไม่เป็นไปตามหลักเกณฑ์กองมากเกิน ขณะนี้ยังไม่ยอมรับคำตอบ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้เป็นหัวข้อสำหรับ Stack Overflow ปิดให้บริการใน3 ปีที่ผ่านมา ปรับปรุงคำถามนี้ date_rangeฉันใหม่เพื่อนุ่นและกำลังพยายามที่จะใช้ ฉันเจอสิ่งดีๆทุกประเภทสำหรับfreqเช่นBMEและBMSฉันต้องการที่จะสามารถค้นหาสตริงที่เหมาะสมได้อย่างรวดเร็วเพื่อให้ได้สิ่งที่ฉันต้องการ เมื่อวานนี้ฉันพบตารางที่มีรูปแบบสวยงามอยู่ที่ไหนสักแห่งในเอกสาร แต่ชื่อของตารางนั้นผิดเพี้ยนมากจนฉันไม่สามารถใช้การค้นหาเพื่อค้นหาได้อีกในวันนี้

96 python  pandas  documentation  dataframe  frequency 

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

94 python  documentation  python-sphinx  doxygen  docstring 

ปิด . คำถามนี้เป็นคำถามความคิดเห็นตาม ขณะนี้ยังไม่ยอมรับคำตอบ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบพร้อมข้อเท็จจริงและการอ้างอิงได้โดยแก้ไขโพสต์นี้ ปิดให้บริการใน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 

ตามที่กล่าวมาในปัจจุบันคำถามนี้ไม่เหมาะสำหรับรูปแบบถาม & ตอบของเรา เราคาดหวังว่าคำตอบจะได้รับการสนับสนุนจากข้อเท็จจริงการอ้างอิงหรือความเชี่ยวชาญ แต่คำถามนี้อาจก่อให้เกิดการถกเถียงโต้แย้งการสำรวจความคิดเห็นหรือการอภิปรายเพิ่มเติม หากคุณรู้สึกว่าคำถามนี้สามารถปรับปรุงได้และอาจเปิดใหม่ได้โปรดไปที่ศูนย์ช่วยเหลือเพื่อรับคำแนะนำ ปิดให้บริการใน9 ปีที่ผ่านมา โปรดระบุภาษามาร์กอัปขนาดเล็กที่เป็นที่นิยมมากที่สุดและเปรียบเทียบจุดแข็งและจุดอ่อน ภาษาเหล่านี้ควรเป็นมาร์กอัปที่มีวัตถุประสงค์ทั่วไปสำหรับร้อยแก้วทางเทคนิคเช่นสำหรับเอกสารประกอบ (เช่น Haml ไม่นับ) ดูเพิ่มเติม: Markdown กับ ReStructuredText

90 documentation  markdown  markup  restructuredtext  textile 

สมมติว่าเป็นส่วนหนึ่งของการบันทึกโค้ดของคุณ (Javadoc) คุณต้องการระบุว่าความสัมพันธ์ระหว่างองค์ประกอบที่ใช้การเยื้องลึก ฉันจะสร้างรายการที่ซ้อนกันเป็น: องค์ประกอบบางอย่าง องค์ประกอบอื่น ๆ แต่องค์ประกอบอื่น ๆ

90 documentation  javadoc  indentation  nested-lists