表示驼峰式类名中的缩写

发布于 2024-07-17 07:49:14 字数 244 浏览 6 评论 0原文

我正在创建一个 C# 库,并将使用它们使用的协议(TCP、UDP 等)作为大多数公共类的前缀,但我遇到了一个两难的困境:应该是 TCPXxxx 还是TcpXxxx

.NET 框架中似乎没有标准(IPAddressTcpClient)。

使用库时您更喜欢哪一个:TCPXxxxTcpXxxx

I'm creating a C# library and am going to be prefix most of the public classes with the protocol they use (TCP, UDP, etc) and I came to a little dilemma: should it be TCPXxxx or TcpXxxx?

There doesn't seem to be a standard in the .NET framework (IPAddress versus TcpClient).

Which you would prefer when working with a library: TCPXxxx or TcpXxxx?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(6

眉黛浅 2024-07-24 07:49:14

根据设计指南,它应该是 TcpXxxx。

在设计指南中,2 个字母的首字母缩略词均大写,所有其他字母均采用 pascal 大小写。

来自 Cwalina 和 Abrams 的框架设计指南

  • 双字符首字母缩略词的两个字符都大写,驼峰式标识符的第一个单词除外。

<前><代码>系统.IO
公共无效StartIO(流ioStream)

  • 仅将包含三个或更多字符的首字母缩略词的第一个字符大写,驼峰式标识符的第一个单词除外。

MSDN 有一个简短的版本。

It should be TcpXxxx, by the design guidelines.

In the design guidelines, 2 letter acronyms are capitalized, all others are pascal cased.

From Framework Design Guidelines by Cwalina and Abrams:

  • Do capitalize both charaters of two-character acronyms, exception the first word of a camel-cased identifier.
    System.IO
    public void StartIO(Stream ioStream)
  • Do capitalize only the first character of acronyms with three or more characters, except the first word of a camel cased identifier.

MSDN has an abbrieviated, shorter version of this.

挽心 2024-07-24 07:49:14

我总是喜欢想象一个将 WordsLikeThis 转换为类似单词的理论过程,并想象所讨论的名称将如何转换。 一些例子:

TCPSocket -> TCP套接字
TcpSocket-> tcp-socket

显然后者更有意义。

I always like to imagine a theoretical process that converts WordsLikeThis to words-like-this, and imagine how the name in question would convert. Some examples:

TCPSocket -> t-c-p-socket
TcpSocket -> tcp-socket

Clearly the latter makes more sense.

初吻给了烟 2024-07-24 07:49:14

一般来说,当它是 2 个字符的前缀时,将其保留为大写 (IPAddress);当它是 3 个字符或更多字符时,请使用 Pascal 大小写前缀 (TcpXxxx)。

此规则有一些例外(例如,如果前缀是大写的专有名称)。

Generally, when it's a 2-character prefix, leave it uppercase (IPAddress) and when it's 3 characters or more, Pascal-case the prefix (TcpXxxx).

There are a few exceptions to this rule (e.g., if a prefix is a proper name that's uppercase).

安静被遗忘 2024-07-24 07:49:14

您可以考虑将这些类放在名为“TCP”的命名空间中。 如果这样做,那么该命名空间中的函数/类名称将变得更短、更清晰,并且您根本不必担心这个问题。

You might consider putting these classes in a namespace called "TCP". If you do so, then your function/class names in that namespace will get shorter and clearer and you won't have to worry about this issue at all.

初心未许 2024-07-24 07:49:14

我知道这是 C# 编码风格,但我更喜欢 Python PEP 8 风格

注意:在 CapWords 中使用缩写时,请将所有字母大写
的缩写。 因此 HTTPServerError 优于
Http服务器错误。

但是在罗马……一致的代码更好,这就是为什么语言风格指南是一个好主意。

I know this is C# coding style but I prefer the Python PEP 8 Style

Note: When using abbreviations in CapWords, capitalize all the letters
of the abbreviation. Thus HTTPServerError is better than
HttpServerError.

But when in Rome...consistent code is better which is why language style guides are a good idea.

往日 2024-07-24 07:49:14

我知道在 Eclipse 中我可以通过仅使用类型名称的大写字母来快速指定类型,所以我更喜欢小写而不是大写......我不知道 VS 是否可以做同样的事情,但它是 < em>太棒了。

I know in eclipse I can quickly specify a type by using just the capitals letters of the type name so I prefer to under-capitalise rather than over-capitalise... I don't know if VS can do the same but it is fan-tastic.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文