命名用户控件的最佳实践？

Question

我创建了不少用户控件来封装在我的应用程序中多处使用的 GUI 功能。我注意到我通常倾向于描述控件的功能并在名称末尾加上 "Control"，但并非总是如此。我希望标准化命名，并想知道在 .NET 中为用户控件命名是否有最佳实践？

- jasonh

Answer 1

实际上，“Control”是一个相当不错的后缀。考虑创建一个用于名称/地址控制的控件，您需要在名称中添加一些标记，以将其标识为 GUI 而不是逻辑。

因此，我倾向于使用 NameAddressControl。

- H H

Answer 2

我也会在用户控件的尾部添加“Control”后缀。

我的UI模块通常以以下结构为例：

DataEntry
-> DataEntryForm（数据输入表单）
-> DataEntryAddressControl（地址控件）
-> DataEntryNameControl（名称控件）
-> DataEntryAddressItem（地址项目）
-> DataEntryAddressItemCollection（地址项目集合）
-> DataEntryConfirmationDialog（确认对话框）

等等。

这种结构对我们的团队来说非常有效。

- TJF

Answer 3

除非你直接为其他程序员编码，否则尽量使用用户熟悉的东西。引入终端用户不熟悉的术语会导致可靠性问题。

- Nicholas Jordan

---

除了偶尔查看项目并处理非 UI 部分的另一位开发人员外，我是唯一在这个项目上工作的人。 - jasonh

@jasonh：你现在可能是这个项目中唯一的工作人员，但这并不是让其他人感到困难的借口。除非你打算在余生都继续负责这个项目，否则你也必须考虑到你的接班人（以及未来5或10年可能会参与这段代码的任何其他人...）。 - Daniel Pryden

@Daniel Pryden：我知道这一点，但由于我现在没有其他开发人员与我合作，了解什么对他们来说是熟悉的，所以我在这里想知道社区认为我应该做什么。准确地说，是为了让未来的其他人可以维护它。 - jasonh

@jasonh 回复 Daniel：好的，总体来说这是一个不错的方法，但只适用于你自己的工作，当你从主体代码中提取一些内容进行处理时。我的回复几乎是从我的风险管理专家那里抄袭过来的，他拥有40多年的领域经验。我几乎没有使用GUI编写整个应用程序，而是将其作为事后思考的结果进行编码。当我不得不向我的团队领导展示它时，我小心地编写了人类可读的输出，使其更加熟悉。我使用RandomStringGenerator来生成变量名，然后在弄清楚它们的作用后对它们进行命名。现在我已经有了30个正确命名的... - Nicholas Jordan

Answer 4

和其他一些人一样，我们也为用户控件使用Control后缀。（例如ResPayerControl）

- RTipton

Answer 5

UI元素是我仍然使用匈牙利命名法的唯一事物。uctDoesSomething 对我很有效。

这主要是个人偏好，但我发现当我选择控件时，我的思路是“它是什么类型的控件”，然后是“它是做什么的”。在这种情况下，打出“uct”，让智能感知提供给我备选项是有意义的。

- George Mauer

Answer 6

我见过两种方法：

• LoginDateCalendarCtl
• UCLoginDateCalendar

- George Stocker

---

OP 问的是关于 Windows Forms 用户控件，而不是 ASP.NET ;) - Thomas Levesque

Answer 7

firstNameLA.Text="Name:";

firstNameTI.Text="<在此TextInput控件中输入您的姓名>";

1）使用小写驼峰命名法，因为控件默认为私有。

2）使用后缀而不是前缀来进行智能感知等操作，以名称而非类型进行选择。

3）包括类型而不仅仅是“Control”，以提醒您的大脑记住所有那些烦人的花哨UI组件的真实、奇怪的名称。

- Mark Robbins