Codedesign寫作規(guī)范

寫作規(guī)范

  • ‘#’ 開頭的都是,‘#’的數(shù)量決定了類的從屬關(guān)系
  • ‘#’后的文本:‘:’前的是類的名稱,‘:’后的是類的注釋
  • ‘#’下面的為其參數(shù)或者方法,具體見下

參數(shù)

  • 以‘* ’開頭,然后文本內(nèi)容開頭不是‘.’,第一個字母是大寫字母的話,意味著這個參數(shù)是
  • 以‘* ’開頭,然后文本內(nèi)容開頭不是‘.’,第一個字母是小寫字母的話,意味著這個參數(shù)是 普通參數(shù)
  • 如果后面有‘=’,‘=’后面的內(nèi)容為 默認(rèn)參數(shù)
  • 如果后面有‘:’,‘:’后面的內(nèi)容為 參數(shù)的注釋
  • 以‘=>’開頭的是方法的 return 部分,屬于特殊參數(shù)

方法

  • 以‘* ’開頭,且文本內(nèi)容以‘.’開頭的是內(nèi)部方法
  • 以‘.’開頭的是外部方法
  • ‘.’后面的是方法的名稱,‘:’后面的內(nèi)容為方法的注釋

舉例:

## 類: 類的注釋
* .方法:方法的注釋
* 參數(shù)=默認(rèn)參數(shù):參數(shù)的注釋
* Class_param:類的參數(shù)
=> return_res

生成的代碼

class 類:
    """ 類的注釋"""
    def __init__(self):
        """
        """
    def 方法(self,參數(shù) = 默認(rèn)參數(shù), class_param = None):
        self.class_param = ensure_class(class_param,Class_param)
        """
        :param 參數(shù):參數(shù)的注釋
        :param class_param:類的參數(shù)
        """

待定需求:

  1. 網(wǎng)頁端頁邊距
  2. return注釋順序
  3. 加入 import
  4. 自動按照順序掃描根目錄,加上import語句
  5. 如果是a_html_io這樣以"a_"開頭的形式,會去匹配html_io
  6. 左邊編輯框內(nèi)容與右邊生成的代碼內(nèi)容對齊
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 136,568評論 19 139
  • 也感冬雨 作者:宋永基 . 盡管你用了動聽的語言 還是凍僵了我僅有的尊嚴(yán) . 那一抹綠的懸念 也難免你脫臼的利箭 ...
    孔孟之鄉(xiāng)閱讀 189評論 0 0
  • 我躲在屋里 望著院中凳子上的你 五十歲的年紀(jì) 卻被疾病帶走了應(yīng)有的活力 你變得沉默 變得孤僻 變得經(jīng)常為一點小事 ...
    黑白無聲閱讀 212評論 0 1
  • 愛一個人 不需要理由
    夢醒三生夢閱讀 140評論 0 0
  • 155cm的我卻有60kg,一到冬天我就會自動包裹成一個球,走起路來撲哧撲哧的,尤其是爬樓梯,完全是在蠕動。 寒假...
    來不及對你說的話閱讀 328評論 0 0

友情鏈接更多精彩內(nèi)容