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

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

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

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

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

10
การเพิ่ม docstrings ใน namedtuples?
เป็นไปได้ไหมที่จะเพิ่มสตริงเอกสารเข้ากับ namestuple อย่างง่ายดาย? ฉันเหนื่อย from collections import namedtuple Point = namedtuple("Point", ["x", "y"]) """ A point in 2D space """ # Yet another test """ A(nother) point in 2D space """ Point2 = namedtuple("Point2", ["x", "y"]) print Point.__doc__ # -> "Point(x, y)" print Point2.__doc__ # -> "Point2(x, y)" แต่นั่นไม่ได้ตัดมัน เป็นไปได้ไหมที่จะทำด้วยวิธีอื่น?
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.