美文网首页
在协作开发中维持统一的文件格式和代码风格

在协作开发中维持统一的文件格式和代码风格

作者: wonder | 来源:发表于2020-03-12 12:01 被阅读0次

    了解伙伴用什么操作系统

    Windows 和类 Unix 系统在文本处理方面有很多差异,考虑到 WSL 情况可能会复杂点,起项之初便要制定好统一规则:

    • 使用什么作为换行符(当然 LF
    • 文件权限位注意不要动(目前一个项目中,有个文件的可执行权限总是被 Windows 搭档抹掉,恼火!)

    特别关注文件权限问题

    已知在某些环境下(比如 WSL)对文件权限支持有问题,要在这种环境下关闭 filemode 的识别!

    git config core.filemode false
    

    参见 [1] [2]

    了解伙伴用什么编辑器

    了解搭档所用编辑器的默认设定和奇怪癖好,对于不好调教的编辑器,要劝其放弃!

    利用 EditorConfig

    EditorConfig 帮助不同开发人员使用不同编辑器时维持统一的风格,建议起项之初便要引入并妥善配置!

    root = true
    
    [*]
    end_of_line = lf
    indent_style = space
    indent_size = 4
    charset = utf-8
    trim_trailing_whitespace = true
    insert_final_newline = true
    

    利用 .gitattributes

    * text=auto eol=lf
    *.{cmd,[cC][mM][dD]} text eol=crlf
    *.{bat,[bB][aA][tT]} text eol=crlf
    

    制定风格规范

    制定风格规范,并取得所有开发人员的认同。

    Code Review

    特别是在初期,开发负责人要细心检视搭档最近的提交!

    相关文章

      网友评论

          本文标题:在协作开发中维持统一的文件格式和代码风格

          本文链接:https://www.haomeiwen.com/subject/xnsyjhtx.html