15522?1470618394

【支持】 关于项目代码编写及管理的意见 正常


刘移州添加于 2017-01-10 15:23
项目代码编写原则

1、精简单个方法,力求一个方法只做一件事
2、使用有意义的方法名、类名、变量名
3、尽量使代码本身具备自注释功能(命名参考2)
4、每个类、方法、变量名须有相应注释;关键步骤需要有注释;
5、注释的位置、格式需规范,可参见开源项目的代码注释;
6、每个程序需有readme,对于新设计的程序应文档先行,代码逻辑修改,readme需同步修改;readme需包括:程序概述、程序逻辑、测试及部署、可能存在的问题。



项目代码管理
1、使用PULL REQUEST的形式管理
2、master分支为发布版本分支;develop为开发版本分支;开发人员拉取代码亦在develop分支拉取,与master主分支无交集
3、开发人员于develop分支创建分支,提交代码时提交至自己所在分支,不可直接提交至develop;提交时,需在message处写明此次提交修改的具体项

4、trustie平台提请PULL REQUEST,由项目管理人员审阅代码,无误可行后合并到develop;develop分支测试通过后,再由管理人员合并至master分支


关于文档

1、项目相关文档必须具备,如部署文档、运维文档、数据字典等,方便项目成员之间合作及为后来者提供支持、参考

2、每次发布新版本,须发布ISSUE至TRUSTIE平台,以存档


@尹刚(jacknudt)@王涛(wangtao)@湛云(zhanyun)‍ 请参阅,给以修正意见和建议

回复(5)
  • 11879?1461414358
    曾雅蓉 7年前

  • 15712?1471931897
    李乾坤 7年前

    大ossean开始向更高层次发展了!

  • 15522?1470618394
    刘移州 7年前

    描述 已更新。 (查看差别)

  • 5?1460204756
    尹刚 7年前

    很好,以后这方面都要按这个原则实施。具体可以由你来审查研究生提交的代码。 

  • 15522?1470618394
    刘移州 7年前

    描述 已更新。 (查看差别)

0?1470885445
登录后可添加回复
  • 当前状态 新增
  • 选定优先级 正常
  • 指派给 --
  • 里程碑 --
  • 开始日期 2017-01-10
  • 结束日期
  • 预计工时(H) 0.00 小时
  • 完成度 0%
  • 关联Commit

© Copyright 2007~2021 国防科技大学Trustie团队 & IntelliDE 湘ICP备 17009477号

问题和建议
还能输入50个字符 提交

加入QQ群

关注微信APP


×