zoukankan      html  css  js  c++  java
  • 双人项目代码编写规范

    通过对软件工程课程中的软件代码规范的学习,我和我的组员经过商榷,结合我们组的实际情况和所参考的资料特为我们组制定了一套代码编写规范(暂定)。

    首先包括基本规范九条(缩进,行宽,括号,断行&空白{}行,分行,命名,下划线,大小写,注释)。

    之后我们经过查阅资料和讨论总结出如下代码规范:

    1.相对独立的程序代码块之间要留空行,以便区分功能和维护;

    2.较长代码在换行编写时要适当缩进,保证代码的可读性

    3.若循环(判断)语句中有较长的表达式,遵循第2条规范(注意:要在低优先级运算符之前进行换行);

    4.变量/参数较长的,要进行适当划分;

    5.程序文件头注释过长需要用块注释(/**/),函数/方法头注释要在函数/方法头下一行编写,若代码文件中间出现大块注释则上下都要有空行;

    6.函数/方法头注释需列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等;

    7.需要习惯使用函数式编程,且每个函数功能需专一,以便应对以后越来越复杂的应用程序结构,同时也为了方便管理;

    8.当程序的内部的变量/参数/函数较多时,需要将每个变量/参数/函数的命名意义化(用英文表达出变量/参数/函数的功能名,含义)。

  • 相关阅读:
    从Mono 4.0观C# 6.0部分新特性
    (译文)Python中的staticmethod与classmethod
    ubuntu中mysql中文乱码及用python3.x调用
    tornado学习 TCPClient 实现聊天功能
    tornado学习 TCPServer 实现聊天功能
    java基础知识3
    java基础知识5
    JSTL常用标签6
    Java基础知识2
    java基础知识4
  • 原文地址:https://www.cnblogs.com/lz9964/p/13848310.html
Copyright © 2011-2022 走看看