c#编码规范

所需积分/C币:28 2018-09-11 09:31:05 102KB PDF
收藏 收藏
举报

一些编码规范,网上搜集来的,需要的小伙伴可以借鉴一下,毕竟有个好的编码习惯,是一个号团队必不可少的元素
这段代码看起来比上面的好: 在一个类中,各个方法需用一空行,也只能是一行分开。 花括弧需独立一行,而不象等可以跟括号在同一行 不好 在每个运算符和括号的前后都空一格。 好 不好 良好的编程习惯 遵从以下良好的习惯以写出好程序 避免使用大文件。如果一个文件里的代码超过 行,必须考虑将代码分开到不同类中。 避兔写太长的方法。一个典型的方法代码在~行之间。如果一个方法发代码超过行,应该考虑 将其分解为不同的方法。 方法名需能看出它作什么。别使用会引起误解的名字。如果名字一目了然,就无需用文档来解释方法 的功能了。 不好 一个方法只完成一个任务。不要把多个任务组合到一个方法中,即使那些任务非常小。 不好: 使用或 的特有类型,而不是 命名空间中定义的别名类型。 不好 别在程序中使用固定数值,用常量代替。 别用字符串常数。用资源文件。 免使用很多成员变量。声明局部变量,并传递给方法。不要在方法冋共享成员变量ε如果在几个方 法间共享一个成员变量,那就很难知道是哪个方法在什么时候修改了它的值。 必要时使用 别用数字或字符串来指示离散值。 不好 别把成员变量声明为 。都声明为 而使用 不在代码中使用貝体的路径和驱动器名。使用相对路径,并使路径可编程 水远别设想你的代码是在“”盘运行。你不会知道,一些用户在网络或“”盘运行程序。 应用稈序启动时作些“自检”邝确保所需文什和附件在指定的位置。必要时检杳数据库连接。出现任 何问题给用户一个友好的提示。 如果需要的配置文件找不到,应用程序需能自己创建使用默认值的一份。 如果在配置文件中发现错误值,应用程序要拋岀锖误,给岀提示消息告诉用户正确值。 错误消息需能帮助用户解决问题。永迒别用象应用程序岀错发现一错误等错误消息。而应给 出象更新数据库失败ε。请确保登陆和密码正确。的具体消息。 显示错误消息时,除了说哪里错了,还应提示用户如何解决问题。不要用象吏新数据厍失败。这 样的,要提示用户怎么做:更新数据库失败。请确保登陆和密码正确。 显示绘用户的消息要短而友好。但要把所有叫能的信息都记录下来,以助诊断问题。 注释 别每行代码,每个声明的变量都做注释。 在需要的地方注释。可读性强的代码需要很少的注释。如果所有的变量和方法的命名都很有意义,会 使代码可读性很强并无需太多注释。 行数不多的注释会使代码看起来伏雅。但如果代码不清晰,可读性差,那就糟糕 如果应为某种原因使用了复杂艰涩的原理,为程序配备良好的文档和重分的注释。 对一个数值变量采用不是等的数值初始化,给出选择该值的理由。 简言之,要写清晰,可读的代码以致无须什么注释就能理解。 对注释做拼写检査,保证语法和枟点符号的正确使用。 异常处理 不要“捕捉了异常却什么也不做“。如果隐藏了一个异常,你将水远不知道异常到底发生了没有。 发生异常时,给岀友好的消息给用户,但要精确记录错淏的所有可能细节,包括发生的时间,和相关 方法,类名等。 只捕捉特定的异常,而不是一般的异常。 不好 不必在所有方法中捐捉一般异常。不管它,让程序崩溃。这将帮助你在开发周期发现大多数的错误。 你叮以用应用程序缴(线程绂)错淏处理器处理所有一般的异常。遇到”以外的一殷性错误“时,此 错误处理器应该捕捉异常,给用户提示消息,在应用程序关闭或用户选择”忽略并继续“之前记录错误信 不必每个方法都用 当特定的异常可能发生时才使用。比如,当你写文件时,处理异常 别写太大的 模块。如果需要,为个执行的任务编写单独的 模块。这将帮你找出 哪一段代码产生早常,并给用户发出特定的错误消息 如果应用程序需要,可以编写自己的异常类。自定义异常不应从基类 派生,而要继承

...展开详情
试读 9P c#编码规范
立即下载 低至0.43元/次 身份认证VIP会员低至7折
    抢沙发
    一个资源只可评论一次,评论内容不能少于5个字
    img
    水墨丹枫
    • 分享小兵

      成功上传3个资源即可获取

    关注 私信 TA的资源

    上传资源赚积分,得勋章
    最新推荐
    c#编码规范 28积分/C币 立即下载
    1/9
    c#编码规范第1页
    c#编码规范第2页
    c#编码规范第3页

    试读已结束,剩余6页未读...

    28积分/C币 立即下载 >