數字 Python IDE Logo IDE 2025 v2.6.3.1 build 20251111.211026

自定義關鍵詞須遵循 Qt C/C++ Python 編程語言規範,且盡量不與其 保留關鍵詞 發生衝突 (或混淆)。

  1. 基本要求
  2. 關鍵詞 隻可以是大小寫英文字母、數字、_ 的組閤,不可以包含空格,且不能以數字開頭。

    不推薦使用單個英文字母錶示關鍵詞,單個字符的突顯可通過 數字 IDE 查找欄高亮鍵展示。

    關鍵詞必須簡明、扼要、易於理解,不推薦使用字符縮寫。

    特殊情況除外,譬如 FTS_Class 錶示 Full Text Search Class。

    最好能直接錶達齣對象類型,便於後期維護及交流,譬如:

    BaseFind_Class     findFile_fun     line_count     text_list     source_textList

     


  3. 首字母盡量大寫,Q 為 Qt 保留首字符,D 為 樂數軟件 保留首字符。

    最好采用能直接錶達齣對象類型的 _Class 結尾。

    譬如:

    BaseFind_Class     BaseFindClass

    1. 方法
    2. 首字母盡量小寫。

      最好采用能直接錶達齣對象類型的 _Method 結尾,譬如:

      lineCount_method     lineCount_Method

      當然,可藉鑒 Qt 的信號槽機製以 _Slot 結尾,譬如:runFile_Slot。

      在此情況下,最好是沒有 (或少數) 自變量, 自變量由 Qt 信號傳入。

      盡可能不要縮寫,如 lnCount_Method 辨識度就差一些。

    3. 變量
    4. 首字母盡量小寫。

      最好采用能直接錶達齣對象類型的字符開頭,不要在中間添加 _ 字符 (以區彆局部 全局變量)。

      譬如:self.countLine   self.countLineText   self.listText   self.listTextSource

      可縮寫但不要過度,譬如:self.countLn 還好,但 self.couLn 辨識度就很差。

      注意:

      不推薦在開頭或結尾,添加 _ 字符。

      這樣容易與 Qt C/C++ Python 現有關鍵詞相混淆,不便於後期維護。

       

    5. 特性
    6. 定義像 類方法 ,但必須在上部添加裝飾器 @property。

      類特性用法似 類變量 ,但可在特性定義中添加額外附加條件 (或預處理傳入自變量)。

       

      為區彆於類方法, 強烈推薦 去除 _Method。

      譬如: stateCode     stateLine     headerDict

  4. 函數
  5. 首字母盡量小寫。

    最好采用能直接錶達齣對象類型的 _fun 結尾。

    譬如:

    findFile_fun     findFile_Fun

     

  6. 變量
  7. 字符須全小寫,除非必要,纔大寫。

    最好采用能直接錶達齣對象類型的字符結尾,雖然 Python 是動態編程語言。

    譬如: line_count     text_list     source_textList

     

    1. 局部
    2. 必須全小寫,連續單詞的首字符可大寫,中間可添加 _ 字符。

      譬如: amount     count     dump     file_name     no_runList

       

      與保留關鍵詞同名的變量,可采用復數 (或過去式、進行時、動詞變復數名詞)。

      譬如: called     getting     lists     tuples

      注意:

      不推薦 text_lists (易與 lists 混淆),強烈推薦使用 text_list。

      因為單詞組閤已經可以錶明此關鍵詞的用途,且不會與現有 保留關鍵詞 産生混淆。

    3. 全局
    4. 工程級全局變量推薦全大寫,中間可添加 _ 字符。

      譬如:NO_RUN   NO_RUNLIST

      模塊級全局變量同局部變量,中間可添加 _ 字符。

      譬如: no_run     no_runList

      注意:

      不推薦 text_lists (易與 lists 混淆),強烈推薦使用 text_list。

      因為單詞組閤已經可以錶明此關鍵詞的用途,且不會與現有 保留關鍵詞 産生混淆。

    5. 特殊
    6. 采用 __ 結尾或開頭,若無必要,請盡量少用。

      藉鑒自 Python 特殊類方法及特殊全局變量語法規則。

      譬如: __named__