编程风格

介绍

编程风格是一组用于格式化编程指令的准则。遵循一种风格是很有用的，因为它使程序员更容易理解代码、维护代码，并有助于减少引入错误的可能性。指南可以根据组织中使用的编码惯例开发，不同的编程语言会出现不同的风格。编程风格指南的关键元素包括命名约定、注释的使用和格式(缩进、空白)。在某些语言(例如Python)中，缩进用于指示控制结构(因此需要正确的缩进)，而在其他语言中，缩进用于改善代码的可见性和可读性(例如Java)。

命名约定

在命名变量、函数/方法、类、文件等时，遵循命名约定并使用正确的英文拼写是很重要的(这有助于搜索/查找/替换操作)。命名约定用于改善视觉外观，减少阅读和理解代码所需的工作量。它们在不同的编程语言中会有所不同。以下是一个很好的指南:

所有的命名都应该是描述性的。
在可能的情况下避免缩写，但要尽量保持名称的适当组合，简单易懂，但不要太长。
不能使用空格。有些语言会用破折号来表示名字(例如:总高度)，而其他语言会使用下划线(例如:total_height在Python中，SQL)。Java对以小写字母开头的变量使用混合大小写。totalHeight．
常量通常定义为全大写，使用下划线分隔单词。如。MAX_HEIGHT．

注释提高了程序的可读性。与命名约定一样，使用正确的英语拼写也很重要。请注意，不同的编程语言(dis)允许不同的注释样式。

使用注释语法时要保持一致，例如:

           
            //这是一行注释

            /*这是块注释

            超过两行*/

            ——这是评论

在每个文件的开头用注释描述其内容。
每个类的开头都附有注释，说明它的用途以及应该如何使用。
以描述函数用法的注释开始每个函数。
变量名应该具有足够的描述性，不需要注释。如果这是困难的，在声明中提供一个简短的评论。
在整个实现过程中只注释代码中棘手的、不明显的、有趣的或重要的部分。
遵循正常的语法惯例，以确保注释的可读性。

缩进和空白

特定语言的缩进和空白要求取代任何通用准则(如Python要求)。
应该使用空行来分隔代码的逻辑分组
应使用至少2个空白行来分隔功能
对缩进的制表符或空格的选择要一致。调整标签大小，不要太大。

以最好的可读性为目标。最重要的是代码易于阅读和逻辑遵循。例如:

           
            A = (b + c) * d;

            //比:

            = (b + c) * d

            While (true) {}

            //比:

            而(真){}

            For (i = 0;I < 10;我+ +){}

            //比

            (我= 0;< 10;我+ +){}

            if (conditionA && conditionB) {

            doSomething;

            }

            其他{

            doNothing;

            }

            //比:

            如果(conditionA&&conditionB)

            {doSomething;}

            其他{doNothing;}

通用格式

将行长度控制在80个字符以内。
在添加或修改现有代码库时，采用与以前编写的代码相同的格式约定。
是一致的!

适合你的语言和单位的风格

检查您的编程语言使用的特定约定和风格，并使用样式指南编写代码。学院内的许多单位将提供更详细的风格指南或其他关于代码风格的说明，并且应该始终遵循它们。如果你不确定某项作业的写作风格，你应该咨询该单元的教学人员。

你对本页的意见:反馈

信息技术