python編程規範要求(新手入門必知python代碼編寫規範）

注釋是編寫程序中的一種必不可少的、公認的風格規範，對於他人使得他人更易於讀懂理解，對於編寫者也易於維護和修改。

這種默認規則從編程語言一開始到現在一直被認可，每種語言都有其注釋寫法規範，Python也不例外。

Python中的注釋可分為：單行注釋、多行注釋、特殊注釋（編碼聲明注釋）

單行注釋：

Python中以 # 標識為單行注釋，#後面的內容均為注釋內容，不會被解釋器解釋（不能換行哦）

# 判斷C盤下的test.txt是否是文件
os.path.isfile('C:\test.txt')


# 睡眠一秒鐘
time.sleep(1)

當然 # 也可以放在程序結尾的右側

time.sleep(1)  # 睡眠一秒鐘

甚至採用每行使用 # 達到多行注釋的效果

# 這是單行注釋復用實現多行注釋（不推薦）
# 這是單行注釋復用實現多行注釋（不推薦）
print('datapro')

這樣做並非不對，但是不推薦上述這樣使用 ，Python中有其多行注釋的標識符，如下

多行注釋：

當需要寫的注釋內容較多時，Python中可以使用 ”’ ”’（六個單引號） 或 “”” “”” （六個雙引號）作為多行注釋,注釋內容放在中間

'''
這是多行注釋演示
這是多行注釋演示
這是多行注釋演示
'''
print('這是多行注釋演示')

"""
判斷C盤下的test.txt是否是文件
如果是則睡眠一秒鐘
然後輸出 datapro
"""
re = os.path.isfile('C:\test.txt')
if re:
    time.sleep(1)
    print('datapro')

對方法（函數）的注釋說明

def deploy(path, remote_ip, remote_path):
    '''
    這是一個自動部署程序
    :param remote_ip: 遠程IP地址
    :param remote_path: 遠程部署路徑
    :return: 返回值
    '''
    
    pass

對類的注釋說明

class Deploy(object):
  """這是一個部署程序類"""

編碼聲明注釋

Python中還提供了一種用於聲明編碼的注釋，

# -*- coding:UTF-8 -*-

它是Python2.x中遺留下來的，主要是為了解決中文編碼問題，在Python3中此類問題已不存在，但是為了規範、增強代碼的可執行性和及時了解程序的編碼，還是建議加上編碼注釋。

註：-*- 並沒有什麼實際意義，只是為了美觀裝飾了下，所以還可以使用以下風格

# coding:UTF-8
# coding:utf-8
# coding:gbk

另外，有時候Python代碼文件的開頭也有這麼一段

#!/usr/bin/env python

他的作用是 聲明用那個python解釋器去執行代碼，上面的寫法是Linux環境下的寫法 指的是 使用 /usr/bin/env 目錄下的python解釋器去執行代碼

windows環境下只要替換為windows解釋器路徑即可

#!C:software python

其實無論哪種環境只要python解釋器添加到了全局環境變量 上述的聲明都是不需要的。