欢迎光临Jacob·雅各布的博客 !|

Jacob·雅各布

园龄:13年5个月粉丝:5关注:16

C#代码编写规范

C#代码编写规范

C#是一种面向对象的编程语言,它具有强大的功能和灵活的语法。为了提高代码的可读性、可维护性和一致性,我们需要遵循一些编写规范,使得我们的代码更加规范、清晰和优雅。本文将介绍一些常见的C#代码编写规范,包括命名规范、注释规范、格式化规范等。

命名规范

命名是编程中最重要的一个环节,一个好的命名可以让我们快速地理解代码的含义和作用,而一个不好的命名则会造成混乱和误解。因此,我们应该遵循以下几个原则:

  • 使用有意义的单词或缩写,避免使用无意义或模糊的字符。
  • 使用驼峰式或帕斯卡式命名法,根据不同类型的元素使用不同大小写。
  • 使用单数或复数形式,根据元素是否表示一个集合来决定。
  • 使用专业术语或常用词汇,避免使用非标准或难懂的词汇。

具体来说,我们可以参考以下表格:

元素类型 命名法 示例
命名空间 帕斯卡式 System.IO
类型(类、结构体、枚举、接口) 帕斯卡式 StringBuilder, IDisposable
方法 帕斯卡式 ToString, Dispose
属性 帕斯卡式 Length, Count
字段(常量、静态只读) 帕斯卡式 Pi, MaxValue
字段(实例) 驼峰式(可加下划线前缀) name, _age
参数 驼峰式(可加前缀) value, pName
局部变量 驼峰式(可加前缀) index, iCount
事件委托类型 以EventHandler结尾,并带有EventArgs参数类型作为后缀(如果有) EventHandler, KeyPressEventHandler
事件成员名称与事件委托类型相同,并去掉EventHandler后缀(如果有)KeyPres

注释规范

注释是对代码进行说明和描述的文字,它可以帮助我们理解代码的功能、逻辑和目标。注释也是一种沟通方式,它可以让其他人更容易地阅读和修改我们的代码。因此,我们应该遵循以下几个原则:

  • 在类、方法、属性等重要元素之前使用XML文档注释(///),提供简要而清晰地说明,并使用 等标签进行格式化。
  • 在复杂或关键的逻辑之前或之中使用单行注释(//),解释逻辑的含义和目标。
  • 在不常用或难懂的代码之前使用多行注释(/* */),给出详细而完整地说明,并指出来源或参考资料。
  • 尽量保持注释与代码同步更新,避免出现过时或错误的注释。

具体来说,我们可以参考以下示例:

/// <summary>
/// 表示一个学生类
/// </summary>
public class Student
{
// 学生姓名
private string _name;
/// <summary>
/// 获取或设置学生姓名
/// </summary>
public string Name
{
get { return
posted @   Jacob·雅各布  阅读(18)  评论(0编辑  收藏  举报
点击右上角即可分享
微信分享提示
评论
收藏
关注
推荐
深色
回顶
收起
  1. 1 青鸟-ブルーバード いきものがかり
青鸟-ブルーバード - いきものがかり
00:00 / 00:00
An audio error has occurred.

unravel - TK from 凛冽时雨 (TK from 凛として時雨)

词:TK

曲:TK

教えて 教えてよ その仕組みを

僕の中に誰がいるの?

壊れた 壊れたよ この世界で

君が笑う 何も見えずに

壊れた僕なんてさ 息を止めて

ほどけない もう ほどけないよ

真実さえ freeze

壊せる 壊せない 狂える 狂えない

あなたを見つけて 揺れた

歪んだ世界にだんだん僕は

透き通って見えなくなって

見つけないで 僕のことを

見つめないで

誰かが描いた世界の中で

あなたを傷つけたくはないよ

覚えていて 僕のことを

鮮やかなまま

無限に広がる孤独が絡まる

無邪気に笑った記憶が刺さって

動けない 動けない 動けない

動けない 動けない 動けないよ

unravelling the world

変わってしまった

変えられなかった

2つが絡まる 2人が滅びる

壊せる 壊せない 狂える 狂えない

あなたを汚せないよ 揺れた

歪んだ世界にだんだん僕は

透き通って見えなくなって

見つけないで 僕のことを

見つめないで

誰かが仕組んだ孤独な罠に

未来がほどけてしまう前に

思い出して 僕のことを

鮮やかなまま

忘れないで 忘れないで

忘れないで 忘れないで

変わってしまったことにparalyze

変えられないことだらけのparadise

覚えていて 僕のことを

教えて 教えて

僕の中に誰がいるの?