python 註釋

1、單行註釋(行註釋)

Python中使用#表示單行註釋。單行註釋可以作為單獨的一行放在被註釋代碼行之上,也可以放在語句或表達式之後。

<code># 這是單行註釋/<code>
  • 當單行註釋作為單獨的一行放在被註釋代碼行之上時,為了保證代碼的可讀性,建議在#後面添加一個空格,再添加註釋內容。
  • 當單行註釋放在語句或表達式之後時,同樣為了保證代碼的可讀性,建議註釋和語句(或註釋和表達式)之間至少要有兩個空格。
  • 2、多行註釋(塊註釋)

    當註釋內容過多,導致一行無法顯示時,就可以使用多行註釋。Python中使用三個單引號或三個雙引號表示多行註釋。

    <code>'''
    這是使用三個單引號的多行註釋
    '''

    """
    這是使用三個雙引號的多行註釋
    """/<code>

    3、注意

    • 註釋不是越多越好。對於一目瞭然的代碼,不需要添加註釋。
    • 對於複雜的操作,應該在操作開始前寫上相應的註釋。
    • 對於不是一目瞭然的代碼,應該在代碼之後添加註釋。
    • 絕對不要描述代碼。一般閱讀代碼的人都瞭解Python的語法,只是不知道代碼要幹什麼。

    4、關於代碼規範

    Python官方提供有一系列PEP文檔,其中第8篇文檔專門針對Python的代碼格式給出了建議,也就是俗稱的PEP 8。PEP 8文檔地址。


    分享到:


    相關文章: