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. 左边编辑框内容与右边生成的代码内容对齐
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,378评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,356评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,702评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,259评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,263评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,036评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,349评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,979评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,469评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,938评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,059评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,703评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,257评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,262评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,485评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,501评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,792评论 2 345

推荐阅读更多精彩内容

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