寫作規(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ù)
"""
待定需求:
- 網(wǎng)頁端頁邊距
- return注釋順序
- 加入 import
- 自動按照順序掃描根目錄,加上import語句
- 如果是a_html_io這樣以"a_"開頭的形式,會去匹配html_io
- 左邊編輯框內(nèi)容與右邊生成的代碼內(nèi)容對齊