Python|文字檔字串docstrings/註釋comments的差別及用法簡單介紹
關於docstrings與comments:
剛一開始接觸時,所學到的就是「#」;comments:代表著註釋。
#comments註釋:
你會看到很多教學影片或者是網站寫的一些代碼旁邊會出現「#….」。不要說我覺得很好用,我自己也很常使用。因為剛初學的時候,寫出來的代碼總是很「醜」,別人看不懂之餘,自己有時候回頭想複習可能也會忘記,這個程式是用來幹嘛的。
這種時候,在代碼中加入#就很好用了。
依照你用的軟體,用快捷鍵,也可以一次註釋好幾行「程式碼/註解」。
舉例來說:我在是做練習題的時候,想到了第一個解法,但可能有問題,但我不想直接刪掉,於是,就把那個有問題的程式先「註釋」掉,然後再重新寫另一個程式,然後去做對比之類的。這種時候,我就會用註釋/#/comments。
從網路上影片也可以看到人家教學的時候,會在講解之中,「註解」掉一些程式碼,然後演練給你看。就是相同的概念。
“””docstrings”””文字檔字串:
而docstrings 代表的是文字檔字串,寫法為「’’’….’’’」或「”””…..”””」。拆開來說就是「’」符號或者「”」符號前面三個,中間加上你要寫的東西之後,再放三個將之關上。
當你在用文字檔字串的時候,也會發現,裡面的內容物就跟註釋一樣,顏色會改變,但如果你是用文字檔字串,顏色會變成一般字串的顏色。但是,如果你去跑你寫的程式碼,你會發現,他就跟註釋一樣,不會跑出來。就跟這段程式碼沒有在裡面一樣。
但是,如果你今天用的是docstrings,你想要將他列印出來,是可以的。
也就是說,「#註釋」與「’’’文字檔字串’’’」的相同處就是,在程式碼中的應用是不會干擾到程式碼。都可以向註解一樣,寫一些你要記錄的東西。對於要記錄程式碼或者編寫乾淨良好的程式碼都有很好用。