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. 左边编辑框内容与右边生成的代码内容对齐
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,886评论 18 139
  • 也感冬雨 作者:宋永基 . 尽管你用了动听的语言 还是冻僵了我仅有的尊严 . 那一抹绿的悬念 也难免你脱臼的利箭 ...
    孔孟之乡阅读 151评论 0 0
  • 我躲在屋里 望着院中凳子上的你 五十岁的年纪 却被疾病带走了应有的活力 你变得沉默 变得孤僻 变得经常为一点小事 ...
    黑白无声阅读 178评论 0 1
  • 爱一个人 不需要理由
    梦醒三生梦阅读 127评论 0 0
  • 155cm的我却有60kg,一到冬天我就会自动包裹成一个球,走起路来扑哧扑哧的,尤其是爬楼梯,完全是在蠕动。 寒假...
    来不及对你说的话阅读 227评论 0 0