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

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

1156 python  comments  documentation 

ใน Objective C ฉันสามารถใช้#pragma markเพื่อทำเครื่องหมายส่วนของรหัสของฉันในเนวิเกเตอร์สัญลักษณ์ เนื่องจากนี่เป็นคำสั่งตัวประมวลผลล่วงหน้า C จึงไม่สามารถใช้ได้ใน Swift มีการยืนหยัดในเรื่องนี้ใน Swift หรือฉันต้องใช้ความคิดเห็นที่น่าเกลียด?

936 swift  documentation 

ปิด คำถามนี้เป็นคำถามความคิดเห็นตาม ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบข้อเท็จจริงและการอ้างอิงได้โดยแก้ไขโพสต์นี้ ปิดให้บริการใน2 ปีที่ผ่านมา ฉันเคยเห็นรูปแบบการเขียนเอกสารใน Python แตกต่างกันบ้างมีสไตล์เป็นทางการหรือ "เห็นด้วย"

888 python  coding-style  documentation  docstring 

ตามที่เป็นอยู่ในปัจจุบันคำถามนี้ไม่เหมาะสำหรับรูปแบบคำถาม & คำตอบของเรา เราคาดหวังคำตอบที่จะได้รับการสนับสนุนจากข้อเท็จจริงการอ้างอิงหรือความเชี่ยวชาญ แต่คำถามนี้มีแนวโน้มที่จะเรียกร้องการอภิปรายการโต้แย้งการหยั่งเสียงหรือการอภิปรายเพิ่มเติม หากคุณรู้สึกว่าคำถามนี้สามารถปรับปรุงและเปิดใหม่ได้โปรดไปที่ศูนย์ช่วยเหลือเพื่อขอคำแนะนำ ปิดให้บริการใน7 ปีที่ผ่านมา ฉันมีเพื่อนร่วมงานที่ยืนยันว่ารหัสของเขาไม่ต้องการความคิดเห็นมันเป็น "การทำเอกสารด้วยตนเอง" ฉันได้ตรวจสอบรหัสของเขาแล้วและแม้ว่าจะชัดเจนกว่ารหัสที่ฉันเคยเห็นคนอื่นทำ แต่ฉันก็ยังไม่เห็นด้วยว่ารหัสการจัดทำเอกสารด้วยตนเองนั้นสมบูรณ์และมีประโยชน์เช่นเดียวกับการแสดงความคิดเห็นและรหัสที่เป็นเอกสาร ช่วยให้ฉันเข้าใจเขามุมมอง รหัสเอกสารด้วยตนเองคืออะไร มันสามารถแทนที่รหัสความคิดเห็นดีและเอกสาร มีสถานการณ์ที่ดีกว่ารหัสดีและแสดงความคิดเห็น มีตัวอย่างที่รหัสไม่สามารถจัดทำเอกสารด้วยตนเองได้โดยไม่ต้องแสดงความคิดเห็น อาจเป็นเพียงข้อ จำกัด ของตัวเอง แต่ฉันไม่เห็นว่ามันจะเป็นการปฏิบัติที่ดีได้อย่างไร นี่ไม่ได้หมายความว่าจะเป็นข้อโต้แย้ง - โปรดอย่าอธิบายเหตุผลที่ทำไมความเห็นที่ดีและรหัสเอกสารมีความสำคัญสูง - มีแหล่งข้อมูลมากมายที่แสดงสิ่งนี้ แต่พวกเขาไม่เชื่อต่อเพื่อนของฉัน ฉันเชื่อว่าฉันต้องเข้าใจมุมมองของเขาให้มากขึ้นเพื่อโน้มน้าวเขาอย่างอื่น เริ่มคำถามใหม่ถ้าคุณต้องการ แต่อย่าเถียงที่นี่ ว้าวตอบสนองอย่างรวดเร็ว! โปรดอ่านคำตอบที่มีอยู่ทั้งหมดและแสดงความคิดเห็นต่อคำตอบแทนที่จะเพิ่มคำตอบใหม่เว้นแต่คำตอบของคุณจะแตกต่างอย่างมากจากคำตอบอื่น ๆ ทั้งหมดที่นี่ นอกจากนี้พวกคุณที่กำลังโต้เถียงกับการทำเอกสารด้วยตนเอง - นี่คือหลักที่จะช่วยให้ฉันเข้าใจมุมมอง (กล่าวคือแง่มุมที่ดี) ของผู้สอนศาสนารหัสการทำเอกสารด้วยตนเอง ฉันคาดว่าคนอื่นจะลงคะแนนคุณถ้าคุณไม่อยู่ในหัวข้อ

258 documentation  comments 

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

186 objective-c  documentation  comments  doxygen  xcode5 

ดังนั้นฉันจึงเข้าใจวิธีการใช้งานresampleอย่างสมบูรณ์แต่เอกสารไม่ทำงานอธิบายตัวเลือกได้ดี ดังนั้นตัวเลือกส่วนใหญ่ในresampleฟังก์ชั่นจะค่อนข้างตรงไปตรงมายกเว้นสำหรับสองตัวนี้: กฎ: สตริงออฟเซตหรือวัตถุที่เป็นตัวแทนของการแปลงเป้าหมาย อย่างไร: สตริง, วิธีการดาวน์ - หรือการสุ่มตัวอย่างใหม่, เริ่มต้นที่ 'หมายถึง' ดังนั้นจากการดูตัวอย่างให้มากที่สุดเท่าที่ฉันพบทางออนไลน์ฉันสามารถดูกฎที่คุณสามารถทำได้'D'ในแต่ละวัน'xMin'เป็นนาที'xL'เป็นมิลลิวินาที แต่นั่นคือทั้งหมดที่ฉันสามารถหาได้ สำหรับวิธีการที่ฉันได้เห็นต่อไปนี้: 'first', np.max, 'last', 'mean'และ'n1n2n3n4...nx'ที่ NX เป็นตัวอักษรตัวแรกของดัชนีแต่ละคอลัมน์ ดังนั้นจะมีที่ไหนสักแห่งในเอกสารที่ฉันขาดหายไปซึ่งจะแสดงทุกตัวเลือกสำหรับpandas.resampleกฎและวิธีการป้อนข้อมูล? ถ้าใช่ที่ไหนเพราะฉันไม่สามารถหาได้ หากไม่มีตัวเลือกทั้งหมดสำหรับพวกเขาคืออะไร?

184 python  documentation  pandas 

ปิด คำถามนี้เป็นคำถามความคิดเห็นตาม ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบข้อเท็จจริงและการอ้างอิงได้โดยแก้ไขโพสต์นี้ ปิดให้บริการใน2 ปีที่ผ่านมา ปรับปรุงคำถามนี้ ตกลงดังนั้นฉันจึงอ่านทั้งPEP 8และPEP 257และฉันได้เขียนเอกสารจำนวนมากสำหรับฟังก์ชั่นและชั้นเรียน แต่ฉันไม่แน่ใจเกี่ยวกับสิ่งที่ควรไปในโมดูล docstring ฉันคิดว่าอย่างน้อยก็ควรทำเอกสารฟังก์ชั่นและคลาสที่โมดูลส่งออก แต่ฉันก็เห็นบางโมดูลที่แสดงรายชื่อผู้แต่งข้อมูลลิขสิทธิ์ ฯลฯ ใครบ้างมีตัวอย่างของวิธีการที่ดีงูหลาม docstring มีโครงสร้างหรือไม่

167 python  documentation  module 

ปิด คำถามนี้เป็นคำถามความคิดเห็นตาม ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบข้อเท็จจริงและการอ้างอิงได้โดยแก้ไขโพสต์นี้ ปิดให้บริการใน2 ปีที่ผ่านมา ปรับปรุงคำถามนี้ ฉันกำลังเริ่มต้นด้วย Python และฉันมีพื้นหลัง PHP ที่แข็งแกร่งและใน PHP ฉันมีนิสัยที่จะใช้javadocเป็นแม่แบบเอกสาร ฉันสงสัยว่าjavadocมีสถานที่เป็นdocstringเอกสารใน Python หรือไม่ อนุสัญญาที่จัดตั้งขึ้นและ / หรือสมาคมที่เป็นทางการที่นี่คืออะไร? เช่นนี้เป็นสิ่งที่ซับซ้อนเกินกว่าที่จะเข้ากับความคิดของ Python หรือฉันควรจะพยายามรัดกุมที่สุดเท่าที่จะทำได้? """ replaces template place holder with values @param string timestamp formatted date to display @param string priority priority number @param string priority_name priority name @param string …

162 python  documentation  javadoc  docstring 

ฉันกำลังเขียนกรอบเล็ก ๆ ที่จะใช้ภายในโดยนักพัฒนาอื่น ๆ ภายใน บริษัท ฉันต้องการให้ข้อมูล Intellisense ที่ดี แต่ฉันไม่แน่ใจว่าจะบันทึกข้อยกเว้นได้อย่างไร ในตัวอย่างต่อไปนี้: public void MyMethod1() { MyMethod2(); // also may throw InvalidOperationException } public void MyMethod2() { System.IO.File.Open(somepath...); // this may throw FileNotFoundException // also may throw DivideByZeroException } ฉันรู้ว่ามาร์กอัปสำหรับการยกเว้นเอกสารคือ: /// <exception cref="SomeException">when things go wrong.</exception> สิ่งที่ฉันไม่เข้าใจคือวิธีการจัดทำเอกสารข้อยกเว้นโยนโดยรหัสที่เรียกว่า MyMethod1() ? ฉันควรบันทึกข้อยกเว้นที่ถูกส่งไปด้วยหรือไม่ MyMethod2() …

139 c#  .net  documentation  intellisense 

วิธีการทำเอกสารวิธีการที่มีพารามิเตอร์โดยใช้สตริงเอกสารคู่มือของงูใหญ่? แก้ไข: PEP 257ให้ตัวอย่างนี้: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part (default 0.0) """ if imag == 0.0 and real == 0.0: return complex_zero ... นี่เป็นข้อตกลงที่นักพัฒนางูหลามส่วนใหญ่ใช้หรือไม่ Keyword arguments: <parameter name> -- Definition (default value if any) …

139 python  documentation  documentation-generation 

ปิด. คำถามนี้ไม่เป็นไปตามหลักเกณฑ์กองมากเกิน ขณะนี้ยังไม่ยอมรับคำตอบ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้เป็นหัวข้อสำหรับ Stack Overflow ปิดให้บริการเมื่อปีที่แล้ว ปรับปรุงคำถามนี้ ฉันพยายามค้นหาเอกสารเพื่อใช้ FFmpeg C API ดูเหมือนว่าจะมีเฉพาะเอกสารบรรทัดคำสั่งเท่านั้น มีเอกสาร / บทช่วยสอน / ลิงค์ที่ดีหรือไม่?

120 c  api  documentation  ffmpeg 

ปิด . คำถามนี้เป็นคำถามความคิดเห็นตาม ขณะนี้ยังไม่ยอมรับคำตอบ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบได้ด้วยข้อเท็จจริงและการอ้างอิงโดยแก้ไขโพสต์นี้ ปิดให้บริการใน6 ปีที่ผ่านมา ปรับปรุงคำถามนี้ TeX / LaTeX เยี่ยมมากฉันใช้มันหลายอย่าง ข้อดีบางประการคือ: มันใช้ไฟล์ข้อความวิธีนี้จะทำให้ไฟล์อินพุตแตกต่างกันและมีเครื่องมือมากมายในการทำงานกับข้อความ มีความยืดหยุ่นมาก มันมีเค้าโครงที่มั่นคง: ถ้าฉันเปลี่ยนบางอย่างในตอนเริ่มต้นของเอกสารมันจะไม่ส่งผลกระทบต่อสิ่งอื่น ๆ ในตอนท้ายของเอกสาร มีส่วนขยายมากมายเพื่อให้บรรลุเป้าหมายที่แตกต่างกัน (ผู้สืบทอดจะเริ่มโดยไม่มีส่วนขยาย แต่จะมีระบบส่วนขยายที่ดี) คุณสามารถใช้เครื่องมือควบคุมการสร้างมาตรฐานเพื่อรองรับเอกสารที่ซับซ้อนได้ (ขอบคุณ dmckee) คุณสามารถห่อหุ้มโซลูชันและคัดลอกและวางลงในเอกสารใหม่หรือส่งให้ผู้อื่นเรียนรู้จาก (ขอบคุณ dmckee) แต่ในทางกลับกันสิ่งเล็กน้อยบางอย่างก็ไม่ดี: มันยากที่จะเรียนรู้ในช่วงเริ่มต้น การควบคุมตำแหน่งของภาพมีความซับซ้อน บางสิ่งเป็นเพียงเล็กน้อยที่ตอบโต้ได้ง่าย บางครั้งคุณต้องพิมพ์มากเกินไป (เริ่ม {itemize} ... \ end {itemize}) ดังนั้นจึงมีผู้สืบทอด / ทางเลือกแทน LaTeX หรืออย่างน้อยก็เป็นผู้สมัครที่น่าสนใจสำหรับทางเลือกในการพัฒนา ผู้สืบทอดที่แท้จริง / ทางเลือกที่ดีจะรักษาข้อดีและแก้ไขข้อเสียหรืออย่างน้อยก็บางอย่าง

118 documentation  latex  tex 

ปิด . คำถามนี้เป็นคำถามความคิดเห็นตาม ขณะนี้ยังไม่ยอมรับคำตอบ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบได้ด้วยข้อเท็จจริงและการอ้างอิงโดยแก้ไขโพสต์นี้ ปิดให้บริการใน2 ปีที่ผ่านมา ปรับปรุงคำถามนี้ ฉันกำลังเขียนคลาสที่มีน้ำหนักเบาซึ่งมีแอตทริบิวต์ที่ตั้งใจให้สามารถเข้าถึงได้แบบสาธารณะและบางครั้งจะถูกแทนที่ในการโต้ตอบที่เฉพาะเจาะจงเท่านั้น ไม่มีข้อกำหนดในภาษา Python สำหรับการสร้าง docstrings สำหรับแอตทริบิวต์คลาสหรือแอตทริบิวต์ประเภทใด ๆ สำหรับเรื่องนั้น วิธีที่คาดหวังและได้รับการสนับสนุนควรมีวิธีใดในการบันทึกแอตทริบิวต์เหล่านี้ ตอนนี้ฉันกำลังทำสิ่งนี้: class Albatross(object): """A bird with a flight speed exceeding that of an unladen swallow. Attributes: """ flight_speed = 691 __doc__ += """ flight_speed (691) The maximum speed that such a bird …

115 python  class  documentation  docstring  class-attributes 

มีมาตรฐานในการตีความไวยากรณ์ของอินเทอร์เฟซฟังก์ชันในเอกสาร API หรือไม่และถ้าใช่จะกำหนดอย่างไร นี่คือตัวอย่างวิธีการเปลี่ยนสีของรายการคู่มือการเขียนสคริปต์ JavaScript สำหรับ Photoshop สำหรับฟังก์ชัน "fillColor": fillPath ([fillColor] [, mode] [, opacity] [, preserveTransparency] [, feather] [, wholePath] [, antiAlias]) ความหมายของเครื่องหมายวงเล็บคืออะไรและเหตุใดจึงมีเครื่องหมายจุลภาคในวงเล็บ สิ่งนี้เกี่ยวข้องกับการเรียกตัวอย่างต่อไปนี้อย่างไร myPath.fillPath(myNewColor) myPath.fillPath(mynewColor, { mode: RGB, opacity: .5 })

106 api  documentation 

ใน JSDoc เอกสารที่ดีที่สุดที่ฉันสามารถหาได้แสดงให้ใช้สิ่งต่อไปนี้หากคุณมีอาร์เรย์ประเภทเฉพาะ (เช่นอาร์เรย์ของสตริง) เป็น: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } คุณจะแทนที่เครื่องหมายคำถามด้านล่างเพื่อระบุอาร์เรย์ของวัตถุได้อย่างไร /** * @param {???????} myObjects All of my equally awesome objects */ function blah(myObjects){ //stuff here... }

105 javascript  documentation  jsdoc