ดาวไม่ได้ใช้งานดาวไม่ได้ใช้งานดาวไม่ได้ใช้งานดาวไม่ได้ใช้งานดาวไม่ได้ใช้งาน
 

     ในภาษาไพทอน มี Attributes ที่เรียกว่า docstring หรือ  __doc__ จะใช้เพื่ออธิบายหน้าที่ของคลาสตามที่ผู้เขียนได้สร้างขึ้น สามารถเรียกใช้ได้ตลอดเวลาถ้าหากกำหนดข้อความเอาไว้ แต่ถ้าเราไม่ได้กำหนดข้อความอธิบายไว้ ก็จะไม่มี Attributes นี้ ซึ่งเราสามารถใช้เพื่อตรวจสอบว่าคลาสแต่ละคลาสได้ออกแบบมาเพื่อวัตถุประสงค์ใด และในบทความนี้เราจะมาพูดถึงลักษณะและการใช้งาน docstring หรือ __doc__ ในภาษาไพทอนกัน

ลักษณะของ docstring

- หากเป็นภาษาอังกฤษควรขึ้นต้นด้วยพิมพ์ใหญ่และลงท้ายด้วยจุด

- ควรเป็นคำอธิบายสั้นๆ

- การประกาศ docstrings ควรจะประกาศโดยใช้ triple single quotes('''...''') หรือ triple double quotes("""...""") และควรอยู่ด้านล่างของคลาสหรือฟังก์ชัน 

- ฟังก์ชันทั้งหมดควรมี docstring 

- การใช้งาน docstring สามารถเข้าใช้งานได้โดยคำสั่ง __doc__ 

ตัวอย่างที่ 1 

def my_function(x):
    """
    สรุป

    สามารถอธิบายฟังก์ชันเพิ่มเติมได้

    พารามิเตอร์:
    x(int): สามารถอธิบายพารามิเตอร์ได้ x

    Returns:
    int: สามารถอธิบายค่าส่งกลับได้

    """
    return x

print(my_function.__doc__)

ผลลัพธ์

การใช้งาน __doc__

ผลลัพธ์ที่ 1 

ตัวอย่างที่ 2 

def my_function():
    """\tการใช้งาน doctring
ควรกำหนดไว้ใต้ฟังก์ชัน"""


print(my_function.__doc__)

ผลลัพธ์

การใช้งาน escape character

ผลลัพธ์ที่ 2

     ซึ่งเราสามารถที่จะใช้ escape character หรือตัวอักษรพิเศษในการควบคุมการแสดงผลได้อีกด้วย

ความแตกต่างระหว่าง comment(#) และ docstrings (__doc__)

     การ Comments เป็นสิ่งที่นักพัฒนาทำเอาไว้เพื่อให้ผู้อ่านเข้าใจซอร์สโค้ด อธิบายตรรกะหรือส่วนหนึ่งของมันที่ใช้ในโค้ด จะเขียนโดยใช้สัญลักษณ์ # ในขณะที่ Docstrings ตามที่กล่าวไว้ข้างต้น จะเป็นการใช้เพื่ออธิบายหน้าที่ของคลาสตามที่ผู้เขียนได้สร้างขึ้น สามารถเรียกใช้ได้ตลอดเวลาถ้าหากกำหนดข้อความเอาไว้ ซึ่งจะเชื่อมโยงกับทั้ง โมดูล ฟังก์ชัน คลาส และ เมธอด

 

 

ช่องทางการศึกษาเพิ่มเติมเกี่ยวกับ Docstring

ไพทอน การสร้างคลาส การเขียนโปรแกรมแบบออปเจ็ค Create Class OOP

ไพทอน คุณสมบัติที่ไพทอนสร้างให้เมื่อสร้างคลาส กับ Built-In Class Attributes

การสร้างฟังก์ชั่น ส่งค่าออกจากฟังก์ชั่นไพทอน The return Statement

การแยกและตัดช่องว่างข้อมูลชนิด String (สตริง) ในไพทอน

การเปลี่ยนลักษณะและการจัดแนวของข้อมูลชนิด String (สตริง) ในไพทอน

กระทู้ล่าสุดจากเว็บบอร์ด
หัวข้อกระทู้
ตอบ
เปิดดู
ล่าสุด
แนะนำหนังสือ Pre-Order PHP - high-performance ด้วย Swoole
โดย mindphp อ 24 พ.ย. 2020 4:47 pm บอร์ด Programming - PHP
0
9
อ 24 พ.ย. 2020 4:47 pm โดย mindphp
จ่ายเงินสมทบประกันสังคม มาตรา 33 , 39
โดย milk2533 อ 24 พ.ย. 2020 3:08 pm บอร์ด Accounting software & ERP โปรแกรมบัญชี ระบบอีอาร์พี
0
5
อ 24 พ.ย. 2020 3:08 pm โดย milk2533
ออกหัก ณ ที่จ่าย ค่าขนส่งคน , ค่าขนส่งของ ต่างกันอย่างไร
โดย milk2533 อ 24 พ.ย. 2020 2:51 pm บอร์ด Accounting software & ERP โปรแกรมบัญชี ระบบอีอาร์พี
0
6
อ 24 พ.ย. 2020 2:51 pm โดย milk2533
การเขียนสั่งจ่ายเช็ค อย่างไร
โดย milk2533 อ 24 พ.ย. 2020 1:29 pm บอร์ด Accounting software & ERP โปรแกรมบัญชี ระบบอีอาร์พี
0
4
อ 24 พ.ย. 2020 1:29 pm โดย milk2533
การจัดสินค้าขาย
โดย milk2533 อ 24 พ.ย. 2020 12:49 pm บอร์ด Microsoft Office Knowledge & line & Etc
0
16
อ 24 พ.ย. 2020 12:49 pm โดย milk2533
FIFO สินค้าตามวันหมดอายุ
โดย milk2533 อ 24 พ.ย. 2020 11:17 am บอร์ด Share Knowledge
0
9
อ 24 พ.ย. 2020 11:17 am โดย milk2533
การนับสต๊อคสินค้าเซเว่น
โดย milk2533 อ 24 พ.ย. 2020 11:15 am บอร์ด Share Knowledge
0
8
อ 24 พ.ย. 2020 11:15 am โดย milk2533
ทริป กางเต็นท์ ใกล้กรุงเทพ
โดย milk2533 จ 23 พ.ย. 2020 1:04 pm บอร์ด พูดคุยเรื่องทั่วไป จับฉ่าย
0
17
จ 23 พ.ย. 2020 1:04 pm โดย milk2533