註釋和文件字串的原則是：有助於對程式的閱讀理解；

python沒有型別資訊，IDE不能幫助提示，如果沒有註釋，動態語言就很難理解；

註釋不宜太多也不能太少，一般建議建議有效註釋量（包括文件字串）應該在20%以上。 撰寫好的註釋有以下建議：

註釋描述必須準確、易懂、簡潔，不能有二義性；

避免在註釋和文件字串中使用縮寫，如果要使用縮寫則需要有必要的說明；

修改程式碼時始終優先更新相應的註釋/文件字串，以保證註釋/文件字串與程式碼的一致性；

有含義的變數，如果不能充分自注釋，則需要新增必要的註釋；

全域性變數建議新增詳細註釋，包括對其功能、取值範圍、哪些函式或過程修改它以及存取時注意事項等的說明；

註釋：

（必須遵守）（規則）：

1、類和介面的文件字串寫在類宣告（class ClassName:）所在行的下一行，並向後縮排4個空格；

class TreeError(libxmlError):
    """
    功能描述：
    介面：
    """