为了增强代码的可理解性及可维护性,公司或项目通常会采用统一的命名规则,下面为一些代码命名规范,可作为学习编程语言的参考。
(1)Pascal规则命名方法和类型
首字母必须大写,后续连接词的首字母也均为大写。例:创建一个公共类,并在此类中创建一个公共方法,示例如下:
public class User //创建一个公共类
{
public void GetUserInfo() //在公共类中创建一个公共方法
{
}
}
(2)Camel规则命名局部变量和方法参数
名称中第一个单词的首字母小写,后续连接词的第一个字母均为大写。例:创建一个字符串变量和一个公共方法,示例如下:
string strUserName; //声明一个字符串变量
public void AddUserMember(string strUserId, byte[] byPassword); //创建具有两个参数的公共方法
(3)成员变量前添加前缀 ‘_’ ,接口名称前添加前缀‘I’,示例如下:
public class UserName //创建一个公共类
{
private string _userAge; //声明一个私有变量
}
public interface Iconvertible //创建一个公共接口
{
}
(4)将方法命名为动宾短语,示例如下:
public class MessageInfo
{
public int GetMessageId(int index) //创建一个方法GetMessageId
{
}
public int GetMessageData(int index) //创建一个方法GetMessageData
{
}
}
(5)将成员变量声明在类的顶端,并换行将它和方法分开,示例如下:
public class MessageInfo
{
private int _messageIndex; //在类顶端声明变量
private int _messageId; //在类顶端声明变量
public int GetMessageId(int index) //创建一个方法GetMessageId
{
}
}
(6)用有意义的名字命名空间,比如产品名,公司名,示例如下:
namespace Lol
{
}
namespace WeGame
{
}
(7)使用某个控件的值时,尽量命名局部变量,示例如下:
public string GetTitle
{
string title = lbl_Title.text; //定义一个局部变量
return (title);
}