ASP.NET 控件的命名准则是什么？

Question

我们正在制定我们希望在开发团队中使用的设计指南，并且今天开始讨论如何命名 ASP.NET 控件。 我说的是我们的好朋友标签、文本框、按钮等。

我们提出了以下三种可能性并进行了投票：（示例是用于输入/显示名字的文本框）

1. 将控件类型作为后缀添加到控件 ID ： [FirstName_TextBox] 或 [FirstName_tbx]
2. 将控件类型添加为控件 ID 的前缀 [tbxFirstName]
3. 将控件的 ID 设置为 FirstName 和名称相关字段（如文本框或验证器的标签）如选项 2 [lblTextBox] 中。

我们最终决定使用选项 2。它不像选项 1 那样冗长，而且我喜欢它在控件名称之前指定它是什么控件。

我的问题是 Microsoft 是否发布了有关这些前缀的任何指南，或者您对我们的决定是否有任何意见。

Answer 1

当您将“TextBox1”添加到页面时，Visual Studio 添加它的原因是因为 Microsoft 无法知道您打算如何使用它。 将其命名为“Control1”会太混乱，因为它可以是任意数量的控件。

Microsoft 提供了有关 OO 命名约定的一般指南，但没有专门针对命名 UI 控件。 由于 UI 控件最终是代码中使用的变量，因此它们应该遵循与任何其他变量相同的约定 - 没有匈牙利符号前缀。

• msdn.microsoft.com/en-us/library/xzf533w0(vs.71) 71)
• msdn.microsoft.com/en- us/library/ms229002(VS.80)

主要原因是...

• 控件类型可能从文本框更改为列表框，然后所有关联的代码都必须修复（前面已提到）
• 您的代码应该更加关注与控件的内容有关，而与控件的类型无关。 当您关心控件的类型时，您开始依赖某些功能并破坏封装 - 您应该能够轻松地交换控件，而无需更改太多或任何代码。 （基本的OOP原则）
• 为标准控件想出前缀是相当容易的，但是每天都在开发新的控件。 您可以制作自己的 WebUserControl，也可以购买一组第三方控件。 您将如何决定自定义控件使用哪个前缀？您的代码不应关注控件的类型，而应关注其中包含哪些信息。

示例

• txtFirstName => 名字或名字
• txtState => 状态或状态
• cboState => state 或 State（更改控件类型的主要示例 lstState 或 rdoState 怎么样 - 它们都应该具有相同的名称，因为您的代码不关心控件的类型，而不关心用户选择的状态）
• ctlBilling => billingAddress 或 BillingAddress （自定义控件 - 使用匈牙利表示法，该控件是什么并不是很明显，但是有了一个有意义的名称，我开始理解其中包含的信息。即 billingAddress.Street、billingAddress.FullAddress 等）

Answer 2

不确定微软的官方标准，但这就是我在我的开发生涯中所做的。

我通常在控件功能的名称前面缩写控件类型。
我保留了缩写小写和控件名称 CamelCase。

例如，用户名的文本框变为 tbUserName

这是我使用的标准缩写的列表：

Abbr     -  Control

btn  -  Button
cb   -  CheckBox
cbl  -  CheckBoxList
dd   -  DropDownList
gv   -  GridView
hl   -  Hyperlink
img  -  Image
ib   -  ImageButton
lbl  -  Label
lbtn -  LinkButton
lb   -  ListBox
lit  -  Literal
pnl  -  Panel
ph   -  PlaceHolder
rb   -  RadioButton
rbl  -  RadioButtonList
txt  -  Textbox

Answer 3

我发现大多数时候我关心的是控件的用途，而不是当前使用什么控件类型来捕获该数据，因此我更喜欢在控件类型之前选择信息类型，因此我可以在IDE 中的排序列表：

• AgeRangeDropDownList
• AgreedToTermsCheckBox
• FirstNameTextBox
• LastNameTextBox

VS：

• chkAgreedToTerms
• ddlAgeRange
• txtFirstName
• txtLastName

Answer 4

我不确定有关 ASP.NET 的指南，但在 Microsoft 的《框架设计指南》一书中，有几个有关类成员命名的最佳实践指南。 由于 ASP.NET 控件在大多数情况下会产生适当类型的受保护字段，因此我认为这些命名准则也适用于 ASP.NET 控件。 事实上，代码分析并不区分控制引用字段和其他字段。

这些指南建议使用暗示逻辑用途的命名方案，而不是类型描述性变体。 有几个原因。 对于开发人员来说，前缀意味着一种类型，由于以后的更改，该类型可能会不正确。 它在代码维护方面增加了一个额外的步骤。 如果将 Button 控件更改为 LinkBut​​ton 控件，则还需要更改名称以更正前缀。

因此，我会调用该控件 FirstNameEdit 等......

Answer 5

Microsoft 确实在这里提供了一些指导。

当您将控件拖到 Web 表单上时，您会自动获得类似“TextBox1”的内容。 IDE 告诉您应该根据您的特定需求更改“1”部分。

在这种情况下，“TextBoxFirstName”似乎是正确的选择。

Answer 6

我更喜欢选项 1 的两个原因：

1. FirstNameTextBox 与我的业务对象更匹配。
2. 与 IntelliSense 配合使用更方便。

话虽如此，我正在考虑更改为 FirstNameCtrl，因为 csgero 指出了更改控件类型的原因。 那么为什么要费心使用任何后缀或前缀来减少/消除与 asp/win 表单属性冲突的可能性。

Answer 7

我认为使用选项 1 更好，因为可以很容易地通过其含义及其用法找到该字段，以便以后理解编程编码。 此外，使用 IntelliSense 可以更方便地找到我们在编程代码中使用该字段的位置。 因此我可以通过有意义的字段的名称找到正确的控件。 我不记得我对该字段使用哪种控件，但我可以通过使用有意义的字段名称而不是控件类型来找到该字段，例如我想查找“城市”控件，我只需输入“城市”，智能将向我显示该控件的所有信息，但如果我不记得我使用的是哪种控件，我不知道该开始......

Answer 8

Abbreviation    ||   ASP.NET Control

标准控件：

btn Button

cb CheckBox

cbl CheckBoxList

ddl DropDownList

fu FileUpload

hdn HiddenField

lnk Hyperlink

img Image

ibtn(btn) ImageButton

lbl Label

lbtn(btn) LinkBut

​​ton lb ListBox

lit Literal

mv MultiView

pnl Panel

ph PlaceHolder

rb RadioButton

rbl RadioButtonList

tbl Table

txt TextBox

v查看

数据控件

dtl DataList

dp DataPager

dtv DetailsView

ets EntityDataSource

fv FormView

gv GridView

lds LinqDataSource

lv - ListView

ods ObjectDataSource

qe QueryExtender

rpt Repeater

smd SiteMapDataSource

sds SqlDataSource

xds XmlDataSource

验证

控件 cpv CompareValidator

ctv CustomValidator

rv RangeValidator

rev RegularExpressionValidator

requiredFieldValidator

与 ValidationSummary

验证控制：

cpv // CompareValidator

ctv CustomValidator

rv RangeValidator

rev RegularExpressionValidator

rfvRequiredFieldValidator

Answer 9

我们也使用第 2 种方法，但我并不完全相信这是一个好方法。 它是“坏”类型的匈牙利表示法，这意味着前缀表示类型（语法）而不是目的（语义）。 这样做的问题是，最初作为 TextBox 的内容可能后来变成 DropDown，然后变成 RadioButtonGroup，并且每次都必须重命名该控件。

Answer 10

几乎每个人都使用匈牙利语风格的前缀（选项 2）。
语义命名不太有用，因为“Firstname”实际上是 texbox.Text 值，而不是文本框本身。

Answer 11

我倾向于使用控件类型作为前缀，然后使用控件的名称，但我总是使用 CamelCase，因此在您的示例中，对于您可能拥有的不同类型的控件。

• TxbFirstName
• DdFirstName
• ChbFirstName

出于智能感知的原因，我也总是完全限定名称控件，所以我不会执行以下任何操作...

• TxbFName
• TxbClientNo
• TxbNoOfCpn

但最终取决于个人喜好

Answer 12

我也一直在为这个问题苦苦挣扎。 我曾经使用“匈牙利风格前缀”。

现在我采取不同的方法，我尝试将控件视为类中的私有字段。 我不会用它们的类型预先修复我的私有字段，那么我为什么要对文本框执行此操作呢？

所以以前是：

var newCustomer = new Customer();
newCustomer.Name = txtName.Value;
newCustomer.Address = txtAddress.Value;
newCustomer.City = txtCity.Value;
newCustomer.HasEnoughMoney = cbHasMoney.Selected;

变成：

var newCustomer = new Customer();
newCustomer.Name = name.Value;
newCustomer.Address = address.Value;
newCustomer.City = city.Value;
newCustomer.HasEnoughMoney = hasMoney.Selected;

说实话，我不在乎“名称”控件是文本框还是其他什么，我只想要它的值。

如果您谈论您的控件或另一个字段/变量还不够清楚，我认为您应该重新考虑该字段/变量的名称或您的类的函数（这意味着它可能有点大？） 。

Answer 13

如果您从代码维护的角度来看，在您两年前编写代码后，最好的表示法是什么。 尽管我们尽力确保表单上没有太多字段，但我们都知道这种情况有时会发生。 如果我们通过预先考虑控件类型来使用匈牙利类型表示法，我认为会更容易看到该值来自哪里，而不必在变量名称不明显的情况下找出它。 如果您使用任何类型的重构工具，那么更改控件的名称将自动更改代码，从而减少更改控制争论。

Answer 14

我认为这里没有正确或错误的答案，无论您决定如何，我认为最重要的方面是在实际编码时保持一致。

Answer 15

我使用 uxCity，这样您就知道它绝对是用户界面控件，而不是其他对象，但如果您从 TextBox 转到 DropDownList，则不需要更改它。

但是，如果我有一个 DropdownList 和 一个文本框，我需要使用 dlCity 和 txtCity
或者我会使用组合 cboCity。

当您的名称仅限于 8 个字符并且没​​有智能感知或调试突出显示时，匈牙利表示法就很常见。 这是一门学科，你可以看到，如果编码风格正确，代码很可能是正确的。 它也用于变量，因此您可以阅读代码并理解它，因为它是 DIY 类型强制。

但是，我确实使用 CityTextbox、CityTextboxLabel
CityUx、CityUxLbl

这完全取决于谁为项目制定标准。

Answer 16

我发现使用匈牙利表示法的唯一原因是 IDE 没有智能感知，很难弄清楚什么是什么，所以 iCounter 是一个整数。

但是使用 Brief 进行开发的时代早已一去不复返了，IDE 会向您显示info in a second

然后你继承了VB.NET代码并且它不区分大小写，那么你该怎么办？

lbl名字，txt名字
一个是标签，另一个是文本框

那么如何在不区分大小写的情况下命名它们并真正知道它们是什么？

ux名字 & uxFirstName 不起作用，

我发现的唯一答案是使用匈牙利表示法，是的，我吐在嘴里。 然后又是 vb.net，它应该区分大小写，因为 .net 是并且所有都编译为 IL。

Answer 17

不太确定有什么指导方针，我怀疑有，但我也总是使用 2 号！

Answer 18

这些实际上只是基于您的偏好，但是是的，所描述的选项 2 不太详细，甚至在显示其名称之前就向您指示了控件的类型。