Feature ที่น่าสนใจใน Python ที่มีชื่อว่า Document String

FEATURE ที่น่าสนใจใน PYTHON ที่มีชื่อว่า DOCUMENT STRING

Feature ที่น่าสนใจใน Python ที่มีชื่อว่า Document String

ในภาษา Python นั้นมี function build in ตัวหนึ่งที่น่าสนใจมากตัวหนึ่งชื่อว่า Document String หรือเรียกสั้นๆว่า docstring ซึ่งหน้าที่การทำงานของมันก็คือการอ่าน top comment ของฟังก์ชั่นที่เราต้องการรู้ ซึ่งโดยส่วนใหญ่นั้น top comment ใน function จะเป็นการอธิบายสั้นๆถึงการทำงาน และ parameter ที่ส่งไปยัง function ว่ามีอะไรบ้าง เรามาดูกันดีกว่า ว่ามันใช้งานยังไงกัน โดยครั้งนี้ผมจะใช้โปรแกรม ide เขียน python ที่ชื่อว่า Pycharm มันเป็น IDE ที่ใช้งานง่ายเหมาะสำหรับเรียนรู้ Python ซึ่งสามารถ Download ได้จาก Link นี้เลยครับ Pycharm

หลังจากติดตั้งเสร็จก็ทำการ New Project เลือกแบบ Pure Python แล้วก็ Folder ที่จะเอาไว้ Save เก็บไฟล์ code ซึ่งในการติดตั้ง Pycharm นั้นผมเลือก version Python เป็นรุ่น 2.7.8 ครับเพราะเท่าที่ไรดูรุ่น version 2 กับ 3 นั้นไม่ค่อยมีอะไรต่างกันมากและอีกทั้ง framework หรือ library ต่างๆยังรองรับแค่ 2 เป็นส่วนใหญ่จึงตัดสินใจเรียนรู้ที่ version 2 เป็นหลักครับ

pycharm

 

FEATURE ที่น่าสนใจใน PYTHON ที่มีชื่อว่า DOCUMENT STRING

เมื่อสร้าง Project เสร็จให้ทำการคลิกขวา New -> Python File ตามรูปเลยครับ โดยที่ผมตั้งชื่อไฟล์ว่า test_myfunction ครับ

จากนั้นผมจะทำการสร้าง function หรืออาจเรียกว่า module ขึ้นมาอัน 1 มีชื่อว่า sumEvent(x,y) โดยจะรับค่า x เป็นค่าเริ่มต้น และ y เป็นค่าสิ้นสุดในการวนหาจำนวนคู่แล้วหาผลรวมของเลขคู่ระหว่าง x กับ y โดยมีโค้ดดังนี้ครับ

[sourcecode language=”python”]
def sumEvent(x,y):
”’Summary for x to y only event number .
param x, y is only integer

”’
result = 0
for i in range(x,y):
if(i % 2 == 0):
result += i
print ‘Result is ‘ , result
#end def

print sumEvent.__doc__
sumEvent(1,10)

print ‘\nfilter doc’
print filter.__doc__
[/sourcecode]

จากนั้นเมื่อพิมพ์โค้ดเสร็จก็ทำการรันโดยคลิกขวาที่ไฟล์แล้ว run เลยครับ

FEATURE ที่น่าสนใจใน PYTHON ที่มีชื่อว่า DOCUMENT STRING

เมื่อ Run แล้วจะได้ผลลัพธ์ตามรูปเลยครับ จากโค้ดจากตัว function docstring นั้นเป็นตัวช่วยของ python ซึ่งเรียกว่าดีอีกอันเลยครับเพราะมันจะทำการอ่าน top comment ที่ต้องเป็น Multi Line comment นะครับถึงจะแสดงได้ซึ่งก็คือต้องใช้การ comment ด้วย ”’ เท่านั้นถึงจะแสดงในค่าที่เรียกใช้ docstring ถ้าเป็น # ที่เป็น one line comment ไม่ได้นะครับ โดยการเรียกใช้ docstring นั้นก็ง่ายๆเลยครับคือ ชื่อ function.__doc__

ใช้ under score 2ครั้งหน้าหลังคำว่า doc นั้นเองครับ นอกจาก function ที่เราสร้างขึ้นเองแล้วใส่ multi line top comment แล้ว function อื่นๆใน python ก็จะมี comment พวกนี้อยู่แล้วสามารถเรียกใช้งาน __doc__ ได้เหมือนกันครับ อย่างในตัวอย่างก็เป็น comment อธิบายการทำงานของ function filter ใน python ครับ เรียกได้ว่าทุกตัวที่เป็นฟังก์ชั่นสามารถเรียกใช้ได้หมดครับ แต่จะมี comment แสดงรายละเอียดแบบย่อรึเปล่าอยู่ที่คนพัฒนา function ครับว่าจะใส่ comment อธิบายไว้รึเปล่า

Download SourceCode