C#中有命名参数的样式准则吗
本文关键字:样式 参数 | 更新日期: 2023-09-27 18:24:52
MSDN-冒号后面的空格。这与Objective-C不同,在Objective-C中,我看不到有人在冒号后面使用空格。我想这可能是一个语法高亮显示还没有跟上功能的问题,但我没有使用好的IDE的经验。我在带有Unity的Mac上使用的MonoDevelop既不提供语法着色,也不为命名参数自动完成。那里有很多;如果你知道我想在内心或其他地方存在什么,请告诉我。我还没有找到。
Microsoft在MSDN上发布了一些常识性指南,在我看来,它的一致性与惯例一样重要。如果您还没有这样做,那么值得一看Stylecop的代码样式和标准。
名称指南
发件人:参数名称
选择好的参数名称可以显著提高可用性你的图书馆。一个好的参数名称应该指示什么数据或功能受参数影响。
请在参数名称中使用驼色大小写。请使用描述性参数姓名。
在大多数情况下,参数的名称及其类型应为足以确定参数的用途。
考虑使用基于参数含义的名称,而不是名称基于参数的类型。
在开发人员工具和文档中,参数的类型通常为看得见的通过选择一个描述参数,可以为开发人员提供有价值的信息他们为自己的任务确定合适的成员,并为传递到成员中。
如果这是你想要的,没有人强迫你使用某种特定的风格。根据需要,您可以不使用空格,也可以使用冒号后的空格,或使用冒号前的空格,或者使用冒号周围的空格来编写它。
但是,IMHO,当您只在冒号后面使用一个空格时,它更具可读性。
样式指南应该来自开发团队。每种语言都有自己的习惯用法,应该遵循,但细节需要由团队定义。这同样适用于命名约定。
把它们写下来,传阅,得到大家的同意。如果你在做开源,我相信社区会给你反馈。