精华内容
下载资源
问答
  • 代码书写规范
    千次阅读
    2021-11-09 20:56:53

    输入:

    用符号←表示

    赋值:x←y←1
    公式:y←20*x+2

    变量:

    局部变量不用声明,全局变量要声明

    数组

    A[j]指示数组A的第j个元素。
    A[1…j]表示含元素A[1], A[2], … , A[j]的子数组

    缩进

    用缩进表示模块

    注释

    因为伪代码属于类C语言,所以注释采用C语言中的 “// ”

    选择结构

    用if-then-else来表示

    while循环结构

    while c do
      s
    end

    for 循环

    for var init to limit by incr do
      s
    end

    更多相关内容
  • Verilog代码书写规范

    2020-07-31 05:01:40
    本文主要介绍信号命名的规则和Verilog代码书写规范
  • web代码书写规范

    2019-07-30 12:11:19
    web的代码书写规范,具体介绍了html,js,css,jquery等的书写注意事项
  • C代码: #include int main(void) { printf(That is Right Style\n); return 0; } 在一个标准的C语言程序中,最特殊的莫过于main函数了,而说到底它就是一个函数而已,仅仅因为它地位特殊拥有第一执行权力,...
  • 代码书写规范

    2022-04-13 16:04:15
    书写代码的时候,必须注意代码的缩进规则,我们规定代码缩进规则如下: 在缩进中使用tab缩进,不要是空格缩进 例子: for ( $i=0;$i<$count;$i++ ) { echo 'test'; } 2、括号的使用 在程序中进行结构...

    1、代码缩进

    在书写代码的时候,必须注意代码的缩进规则,我们规定代码缩进规则如下:
    在缩进中使用tab缩进,不要是空格缩进
    例子:

        for ( $i=0;$i<$count;$i++ ) {
            echo 'test';
        }
    

    2、括号的使用

    在程序中进行结构控制代码编写,如if、for、while、switch等结构,大括号传统的有两种书写习惯,分别如下:
    a.{ 直接跟在控制语句之后,不换行,如:

        for ( $i=0;$i<$count;$i++ ) {
            echo 'test';
        }
    

    b.{ 在控制语句下一行,如:

        for ( $i=0;$<$count;$i++ )
        {
            echo 'test';
        }
    

    其中,a是PEAR建议的方式,但是从实际书写中来讲,这并不影响程序的规范和影响用phpdoc实现文档,所以可以根据个人习惯来采用上面的两种方式,但是要求在同一个程序中,只使用其中一种,以免造成阅读的不方便。

    3、嵌入式赋值

    避免嵌入式复制,例如:

    if($a == get_user_info($uid)){
        echo $a;
    }
    

    while ( $a != ( $c = getchar() ) ) {
        ...
    }
    

    4、if else swith for while等书写

    对于控制结构的书写遵循以下规则:
      a.在if条件判断中,如果用到常量判断条件,将常量放在等号或不等号的左边,例如:if ( 6 == $errorNum ) ,因为如果你在等式中漏了一个等号,语法检查器会为你报错,可以很快找到错误位置,这样的写法要注意;
      b.switch结构中必须要有default块;
      c.在 for 和 wiile 的循环使用中,要警惕 continue 、 break 的使用,避免产生类似 goto 的问题;

    5、每行只有一条语句

    切记不要在同一行内写多条语句。
    错误的:

    $foo = 'this'; $bar = 'that'; $bat = str_replace($foo, $bar, $bag);
    

    正确的:

    $foo = 'this';
    $bar = 'that';
    $bat = str_replace($foo, $bar, $bag);
    

    6、字符串

    字符串使用单引号引起来,当字符串中有变量时使用双引号,并且使用大括号将变量包起来。 另外,当字符串中有单引号时,也应该使用双引号,这样就不用使用转义符。

    错误的:

    "My String"                 // no variable parsing, so no use for double quotes
    "My string $foo"                // needs braces
    'SELECT foo FROM bar WHERE baz = \'bag\''   // ugly
    

    正确的:

    'My String'
    "My string {$foo}"
    "SELECT foo FROM bar WHERE baz = 'bag'"
    

    7、段标记

    使用 PHP 的完整标记,防止服务器不支持短标记( short_open_tag )参数。

    错误的:

    <? echo $foo; ?>
    <?=$foo?>
    

    正确的:

    <?php echo $foo; ?>
    

    8、PHP错误

    行代码时不应该出现任何错误信息,并不是把警告和提示信息关掉来满足这一点。 例如,绝不要直接访问一个你没设置过的变量(例如,$_POST 数组), 你应该先使用 isset() 函数判断下。

    确保你的开发环境对所有人都开启了错误报告,PHP 环境的 display_errors 参数也开启了, 你可以通过下面的代码来检查:

    if (ini_get('display_errors') == 1)
    {
        exit "Enabled";
    }
    

    有些服务器上 display_errors 参数可能是禁用的,而且你没有权限修改 php.ini 文件, 你可以使用下面的方法来启用它:

    ini_set('display_errors', 1);
    

    注解

    使用 ini_set() 函数在运行时设置 display_errors 参数和通过 php.ini 配置文件来设置是不一样的,换句话说,当出现致命错误(fatal errors)时,这种方法没用。

    9、常量

    常量遵循和变量一样的命名规则,除了它需要全部大写。尽量使用 CodeIgniter 已经定义好的常量, 如:SLASH、LD、RD、PATH_CACHE 等。

    错误的:

    myConstant  // missing underscore separator and not fully uppercase
    N       // no single-letter constants
    S_C_VER     // not descriptive
    $str = str_replace('{foo}', 'bar', $str);   // should use LD and RD constants
    

    正确的:

    MY_CONSTANT
    NEWLINE
    SUPER_CLASS_VERSION
    $str = str_replace(LD.'foo'.RD, 'bar', $str);
    展开全文
  • Python代码书写规范与基本使⽤
  • 主要介绍了JAVA代码书写规范汇总,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
  • 代码编写规范说明书与 目 录 1 目的 2 范围 3 注释规范 3.1 概述 3.2 自建代码文件注释 3.3 模块类注释 3.4 类属性注释 3.5 方法注释 3.6 代码间注释 4 命名总体规则 5 命名规范 5.1 变量Variable命名 5.2 常量命名 ...
  • huawei代码书写规范.pdf

    2021-09-30 17:14:37
    huawei代码书写规范.pdf
  • VHDL代码书写规范.pdf

    2020-08-21 09:46:40
    VHDL代码书写规范 1 目 次 1 目的 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 2 范围 . . . . . . . . . . ....
  • 给大家全面总结了JavaScript常用代码书写规范,分别利用推荐和不推荐的两种示例代码让大家更能直接的了解书写规范,其实关于javascript代码规范我们应该遵循古老的原则:“能做并不意味着应该做”,好了,下面我们...
  • C++代码书写规范简介

    2021-07-26 15:09:40
    作为代码初学者,了解掌握最基本的代码书写规范知识是必要的。由于代码不仅仅是让程序执行,代码更是给人看的,层次分明清晰的代码和必要的注释的代码可读性更好,能够避免一些BUG或者更容易令人审查识别出BUG,为...

    C++代码书写规范简介

    编码规范并不是必须的,写代码遵守一定的规范,会使阅读代码修改bug轻松一些。

    作为代码初学者,了解掌握最基本的代码书写规范知识是必要的。由于代码不仅仅是让程序执行,代码更是给人看的,层次分明清晰的代码和必要的注释的代码可读性更好,能够避免一些BUG或者更容易令人审查识别出BUG,为未来写大的程序和团队合作养成习惯打下基础。

    这是个比较大的主题,细节很多,需要多借鉴多练习,不断地领悟。在此仅介绍基本的代码书写规范。特别提示,不同的团队的约定不尽相同。

    1、空格

    建议1:函数名之后不要留空格,紧跟左括号‘ (’,以与关键字区别。如:int Fun1(int x) 

    建议2:象 if、 for、 while等关键字之后应留一个空格再跟左括号‘ (’,以突出关键字。如: if (i = 0)

    建议3:定义变量的逗号之后要留空格。在for语句中的分号其后要留空格。如:

    int a, b;

    for (i=0; i<5; i++)

    建议4:赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“ =”、“ +=” “>=”、“ <=”、“ +”、“-”、“*”、“ %”(求余运算符)、 “ &&”、“ <<”、 “ ^”等二元操作符的前后应当加空格。如: a = b; a += 10;

    建议5:一元操作符如“ !”、“ ~”、“ ++”、“-”(负号运算符)、“*”(指针运算符) “ &”(地址运算符)等前后不加空格。

    【顺便提示:操作符也称为运算符,有些操作符有两种作用,如:

    “-”,作为单目操作符“-”是负数操作符,作为算术操作符“-”是减法操作符。

    “*”,作为单目操作符“*”是指针操作符,作为算术操作符“*”是乘法操作符。】

    2、空行

    建议1:在实现函数时,函数与函数之间应加空行。如:

    void Fun1(int x)
    {
      //do something
    }
     
    void Fun2(double y)
    {
      //do something
    }

    建议2:在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行。

    3、变量名、函数名

    建议1:变量,函数,文件命名最好采用英文单词或词组,不要使用拼音,或者无意义的a b c之类的,用有意义的英文单词或其缩写命名能起到在缺少注释的情况下能够给阅读者起提示作用。

    名规则:以大小驼峰式命名法为主,小写字母加下划线为辅

    小驼峰法:第一个单字以小写字母开始,第二个单字的首字母大写。例如:firstName、lastName。

    大驼峰法:每一个单字的首字母都采用大写字母,例如:FirstName、LastName、CamelCase。

    建议2:类名和函数名用大写字母开头能和普通变量区分开。如:

    class ReadBook;

    void DrawImage();

    建议3:变量和参数用小写字母开头的单词组合而成。如:

    int value;

    void SetValueMode(int valueMode);

    建议4:常量全用大写的字母,用下划线分割单词。如:

    const int MAX = 100;

    const int MAX_LENGTH = 100;

    4、注释

    C++中注释主要有两种,程序块的注释常采用“ /*…*/”,行注释一般采用“ //…”。注释主要用在3个地方。1、版权申明,2、函数说明,3、重要或复杂代码提示。

    有时候读代码会跟不上编程者的思维,若代码旁边没有注释,就难以理解其意思,因此适当添加注释不仅能够让自己回忆某行、某段代码的用处,还能方面阅读者理解。建议边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要记得删除。

    5、缩进

    我们看到上面代码中输出语句和return 0;语句前面都有四个空格,这就是缩进。在必要的地方加入缩进,一般是{ }之间加入缩进,可以使代码更加清晰。

    缩进一般是一个制表符(即键盘上的Tab键)或者四个空格,而小古银的习惯是制表符,由于网站会将制表符转换成四个空格,所以你看到的代码都是四个空格的。如:

    int main()
    {
        if (…)
        {
            while (…)
        }
        return 0;
    }

    附:

    google编程规范(中文)https://zh-google-styleguide.readthedocs.io/en/latest/google-cpp-styleguide/

    google编程规范(英文)https://github.com/google/styleguide

    展开全文
  • rustysun同学ASP代码书写规范
  • python书写规范和基本使用,
  • 里为大家送上一份CSS代码书写规范究极指南,包括代码注释和命名规范以及空格缩进等一应俱全,都来自大家平时的约定俗成,绝对值得学习借鉴,需要的朋友可以参考下
  • 编写高质量C++代码 C++编程代码书写规范 改善C++程序的150个建议 编写高质量C++代码 C++编程代码书写规范 改善C++程序的150个建议
  • VC代码书写规范.pdf

    2021-10-02 12:29:04
    VC代码书写规范.pdf
  • Unity项目代码书写规范

    千次阅读 2020-08-26 20:05:16
    书写规范 基础写法 Pascal和驼峰混用,参数用驼峰写法,除参数外,都以Pascal写法为主。 括号建议用换行方式书写 Code 类, 方法, 枚举, public 字段, public 属性, 命名空间的命名规则用:PascalCase. 局部...

    以Google的代码规范为主,稍加改动 https://google.github.io/styleguide/csharp-style.html

    书写规范

    基础写法

    1. Pascal和驼峰混用,参数用驼峰写法,除参数外,都以Pascal写法为主。
    2. 括号建议用换行方式书写

     

    Code

    • 类, 方法, 枚举, public 字段, public 属性, 命名空间的命名规则用PascalCase.
    • 局部变量,函数参数命名规则用: camelCase.
    • private, protected, internal and protected internal 字段和属性的命名规则用: _camelCase.
    • 命名规则不受const, static, readonly等修饰符影响.
    • 对于缩写,也按PascalCase 命名,比如 MyRpc而不是MyRPC.
    • 接口以I,开头..

    Files

    • 文件和文件夹 命名规则为PascalCase, 例如 MyFile.cs.
    • 文件名尽量和文件中主要的类名一直, 例如 MyClass.cs.
    • 通常,一个文件中一个类.

     

    Organization

    • 如果出现,修饰符按下列顺序书写: public protected internal private new abstract virtual override sealed static readonly extern unsafe volatile async.
    • 命名空间在最顶部,using顺序按Sytem,Unity,自定义的命名空间以及字母顺序排序,
    • 类成员的顺序:
      • Group按下列顺序:
        • Nested classes, enums, delegates and events.
        • Static, const and readonly fields.
        • Fields and properties.
        • Constructors and finalizers.
        • Methods.
      • 每个Group内,按下列顺序:
        • Public.
        • Internal.
        • Protected internal.
        • Protected.
        • Private.
      • 接口的实现尽可能安排写在一起

    注释规范

    代码头部注释
    文件名称:文件的名称。
    功能描述:文件的功能描述与大概流程说明。
    作者:创建并编写的人员。
    日期:创建并编写的日期。
    修改记录:若类有所修改,则需要有修改人员的名字、修改日期及修改理由。

    // 文件名称:UserInput.cs

    // 功能描述:玩家输入按键的定义

    // 编写作者:张三

    // 编写日期:2017.7.16

    // 修改记录:

    //      R1:

    //          修改作者:李四

    //          修改日期:2017.7.17

    //          修改理由:使玩家可以自定义输入按键

     

    Using System;

    方法注释

    采用 /// 形式自动产生XML标签格式的注释。包括方法功能,参数含义,返回内容

        /// <summary>

        /// 设置场景的名字.

        /// </summary>

        /// <returns><c>true</c>, 场景名字设置成功, <c>false</c> 场景名字设置失败.</returns>

        /// <param name="sceneName">场景名字.</param>

        public bool SetSceneName(string sceneName)

        {

    }

    类变量注释

    采用 /// 形式自动产生XML标签格式的注释变量含义。

        /// <summary>

        /// 场景的名字

        /// </summary>

        private string mSceneName;

    局部变量注释

    在变量声明语句的后面注释,与前后行变量声明的注释左对齐,注释与代码间以Tab隔开。

    string firstName;   //姓

    string lastName;    //名

    代码行注释

    注释位于代码上行,与代码开始处左对齐,双斜线与注释之间以空格分开

    //设置场景的名字。

    this.mSceneName = sceneName;

    书写示例

    using System;                                           //using写在整个文件最前,多个using按下面层级以及字母排序
    using System.Collections;                               //1.system提供的
    using System.Collections.Generic;
    using UnityEngine;                                      //2.unity提供的
    using UnityEngine.UI;
    using GameDataModule;                                   //3.自定义的namespace
    
    namespace MyNamespace 								    // Namespaces 命名规则为 PascalCase.  
    {      
    	public interface IMyInterface                       // Interfaces 以 'I' 开头
    	{          
    		public int Calculate(float value, float exp);   // 方法函数 命名规则为 PascalCase 
    	}
    
    	public enum MyEnum                                  // Enumerations 命名规则为 PascalCase.
    	{                                  
    		Yes = 0,                                        // Enumerations 命名规则为 PascalCase,并显示标注对应值
    		No = 1,
    	}
    
    	public class MyClass 								// classes 命名规则为 PascalCase.
    	{                          
    		public int Foo = 0;                             // Public 公有成员变量命名规则为 PascalCase.
    		public bool NoCounting = false;                 // 最好对变量初始化.
    		private class Results 
    		{
    			public int NumNegativeResults = 0;
    			public int NumPositiveResults = 0;
    		}
    		private Results _results;                       // Private 私有成员变量命名规则为 _camelCase.
    		public static int NumTimesCalled = 0;
    		private const int _bar = 100;                   // const 不影响命名规则.
    		private int[] _someTable =                  
    		{       
    			2, 3, 4,                 
    		}
    		public MyClass()                                // 构造函数命名规则为 PascalCase.
    		{
    			_results = new Results                      // 对象初始化器最好用换行的方式赋值.
    			{
    				NumNegativeResults = 1,                 // 操作符前后用个空格分割.  
    				NumPositiveResults = 1,           
    			};
    		}
    
        public int CalculateValue(int mulNumber) 
    	{      
            var resultValue = Foo * mulNumber;              // Local variables 局部变量命名规则为camelCase.
            NumTimesCalled++;
            Foo += _bar;
            if (!NoCounting)                                // if后边和括号用个空格分割.
    	    {                                                                          
    			if (resultValue < 0)
    			{                                                                  
    				_results.NumNegativeResults++        
    			} 
    			else if (resultValue > 0)
    			{         
    				_results.NumPositiveResults++;
    			}
    		}
    		return resultValue;
        }
    
        public void ExpressionBodies() 
    	{
          //对于简单的lambda,如果一行能写下,不需要括号
          Func<int, int> increment = x => x + 1;
    
          // 对于复杂一些的lambda,多行书写.
          Func<int, int, long> difference1 = (x, y) => 
    	  {
              long diff = (long)x - y;
              return diff >= 0 ? diff : -diff;
          };
        }
    
        void DoNothing() {}                             // Empty blocks may be concise.
    
        
        void CallingLongFunctionName() 
    	{
          int veryLongArgumentName = 1234;
          int shortArg = 1;
          // 函数调用参数之间用空格分隔
          AnotherLongFunctionNameThatCausesLineWrappingProblems(shortArg, shortArg, veryLongArgumentName);
    	  // 如果一行写不下可以另起一行,与第一个参数对齐
          AnotherLongFunctionNameThatCausesLineWrappingProblems(veryLongArgumentName, 
    															veryLongArgumentName, veryLongArgumentName);
        }
      }
    }

     

     

     

     

     

     

     

    展开全文
  • 阿里代码规范1.40 word版本,摘抄出来,并加以整理,没有出现乱行现象,并有目录可以快捷寻找。
  • C语言代码书写规范总则.pdf
  • Java代码书写规范

    2012-07-26 17:40:54
    Java代码书写规范 1 符号命名规则 符号名包括:模块名,变量名,常量名,方法(函数/子程序)名,数据区名,缓冲区名等。符号命名通常应遵循以下规则: 1.1 通用规则 (1)在所有命名中,都应使用标准的英文单词或...
  • VC代码书写规范[归类].pdf

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 103,001
精华内容 41,200
关键字:

代码书写规范

友情链接: python贪吃蛇代码.zip