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

     ในภาษาไพทอน มี 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 (สตริง) ในไพทอน

กระทู้ล่าสุดจากเว็บบอร์ด
หัวข้อกระทู้
ตอบ
เปิดดู
ล่าสุด
เขียน PHP กับ Array แบบนี้ ระวัง Error นะ
โดย mindphp ส 28 พ.ย. 2020 2:31 am บอร์ด Programming - PHP
0
3
ส 28 พ.ย. 2020 2:31 am โดย mindphp
โปรแกรม ERP แตกต่างจาก โปรแกรมบัญชีอย่างไร
โดย milk2533 ศ 27 พ.ย. 2020 3:05 pm บอร์ด Accounting software & ERP โปรแกรมบัญชี ระบบอีอาร์พี
0
15
ศ 27 พ.ย. 2020 3:05 pm โดย milk2533
ประโยชน์ ของ ERP
โดย milk2533 ศ 27 พ.ย. 2020 12:59 pm บอร์ด Accounting software & ERP โปรแกรมบัญชี ระบบอีอาร์พี
0
12
ศ 27 พ.ย. 2020 12:59 pm โดย milk2533
เรื่องของเคล็ดลับเก็บเงินหลักแสนสำหรับคนเรา สำคัญอย่างไร
โดย medalezga ศ 27 พ.ย. 2020 12:03 pm บอร์ด พูดคุยเรื่องทั่วไป จับฉ่าย
0
14
ศ 27 พ.ย. 2020 12:03 pm โดย medalezga
เครื่องตรวจนับสินค้า (EOB)
โดย milk2533 ศ 27 พ.ย. 2020 11:26 am บอร์ด IOT - Internet of things
0
21
ศ 27 พ.ย. 2020 11:26 am โดย milk2533
PHP 8 มาแล้ว มาพร้อมกับ Feature เพียบ ดูหล่อขึ้นเยอะ เร็วขึ้นด้วย
โดย mindphp ศ 27 พ.ย. 2020 12:45 am บอร์ด MindPHP News & Feedback
0
19
ศ 27 พ.ย. 2020 12:45 am โดย mindphp
ปัญหาย้าย โดเมนแล้ว Wordpress แล้ว Login เข้า admin ไม่ได้ Error ERROR for site owner: Invalid domain for site key
โดย mindphp พฤ 26 พ.ย. 2020 11:05 pm บอร์ด ปัญหาการใช้ phpBB3, SMF, Joomla, Wordpress, CMS, CRM
1
17
พฤ 26 พ.ย. 2020 11:34 pm โดย mindphp
การเข้าใช้งานสำหรับลูกค้าเพื่อซื้อห้องพักหรือขายห้องพัก อโกด้า
โดย milk2533 พ 25 พ.ย. 2020 6:43 pm บอร์ด Microsoft Office Knowledge & line & Etc
0
12
พ 25 พ.ย. 2020 6:43 pm โดย milk2533