Codedesign写作规范

写作规范

类：

• ‘#’ 开头的都是类，‘#’的数量决定了类的从属关系
• ‘#’后的文本：‘:’前的是类的名称，‘:’后的是类的注释
• ‘#’下面的为其参数或者方法，具体见下

参数

• 以‘* ’开头，然后文本内容开头不是‘.’，第一个字母是大写字母的话，意味着这个参数是 类
• 以‘* ’开头，然后文本内容开头不是‘.’，第一个字母是小写字母的话，意味着这个参数是 普通参数
• 如果后面有‘=’，‘=’后面的内容为 默认参数
• 如果后面有‘:’，‘:’后面的内容为 参数的注释
• 以‘=>’开头的是方法的 return 部分，属于特殊参数

方法

• 以‘* ’开头，且文本内容以‘.’开头的是内部方法
• 以‘.’开头的是外部方法
• ‘.’后面的是方法的名称，‘:’后面的内容为方法的注释

举例：

## 类: 类的注释
* .方法:方法的注释
* 参数=默认参数:参数的注释
* Class_param:类的参数
=> return_res

生成的代码

class 类:
    """ 类的注释"""
    def __init__(self):
        """
        """
    def 方法(self,参数 = 默认参数, class_param = None):
        self.class_param = ensure_class(class_param,Class_param)
        """
        :param 参数:参数的注释
        :param class_param:类的参数
        """

待定需求:

1. 网页端页边距
2. return注释顺序
3. 加入 import
4. 自动按照顺序扫描根目录，加上import语句
5. 如果是a_html_io这样以"a_"开头的形式,会去匹配html_io
6. 左边编辑框内容与右边生成的代码内容对齐