当前位置: 首页 > 编程笔记 >

PowerShell编程中的一些命名规则参考

俞博涛
2023-03-14
本文向大家介绍PowerShell编程中的一些命名规则参考,包括了PowerShell编程中的一些命名规则参考的使用技巧和注意事项,需要的朋友参考一下

本文介绍PowerShell自定义函数在使用时的最佳实践(Best Practices)。包括函数名的命名、可选参数、必选参数等。

PowerShell中的函数定义可以很简单的使用一个“function <函数名>{函数体}”的形式去定义。但微软推荐创建函数时遵循以下实践规则。

1、函数名。

使用cmdlet的统一命令规则,即“动词-名词”的形式。如Write-Host,表示输出到主机。如果是获取一个列表,不要使用List作为动词,建议使用Get,如Get-ChildItem。名词部分用一个有意义的英文单词,记得使用单数,不要使用名词的复数形式。如果要列出网卡的一个函数,不要使用ListNetworkCards,而应该使用Get-NetworkCard。这就是关于函数命名的最佳实践。

2、公司前缀。

假定你写一个Get-NetworkCard的函数,洪哥也写了同样一个。那是不是很难区分谁是谁写的?所以,微软建议在函数名的名词部分加上公司前缀,而不加公司前缀的函数,我们一般可以理解为微软发布的。这个公司前缀用编写的两到三个字母为宜,比如洪哥函数名可以命为Get-HGNetworkCard。这里洪哥的前缀用的HG,你的呢?

3、参数的命名要规范

参数要用有意义单词,不要使用-PC作为参数名,你可以用-ComputerName取而代之。如果有时候需要一个文件路径作为一个参数,不要使用-File,因为指代实在是太模糊了。可以使用-Path,这样更明确。虽然没有官方给出一个标准的参数命名的列表,但我们应该参照内置(built-in)的cmdlets所用的那些参数名称。这样其他人使用时才更容易理解,对不对?

4、可选参数

为可选参数定义一个默认值,这是一个很好的习惯。如果用户不管这个参数,那么这个参数也可以被处于已赋值状态。

5、必选参数

虽然PowerShell中不要求定义函数参数时必须指定数据类型,但最佳实践要求我们这样做。如果我们指定了类型,那么用户的输入将被强制转换为我们定义的数据类型,否则都会被当作字符串来对待。

6、写一些注释来作为帮助说明

一个段函数给其他人,没有注释说明,别人很难看懂。即便是自己,不加注释的代码,时间过得久了,也不一定保证能看得懂,对不?

关于PowerShell函数使用的最佳实践(Best Practices),本文就介绍这么多,希望对您有所帮助,谢谢!

 类似资料:
  • 1.【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。 反例: _name / __name / $Object / name_ / name$ / Object$ 2.【强制】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。 说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。 注意,即使纯拼音命名方式也要避免采用。 反例: DaZheP

  • 控制器 只允许使用 a-z、A-Z、0-9 和 _ ,并以大写字母开头,例如:Index.php 模型 只允许使用 a-z、A-Z、0-9 和 _ ,并以大写字母开头,例如:Info.php 视图 只允许使用 a-z、0-9 和 _ ,并以字母开头,例如:index.php 布局 只允许使用 a-z、A-Z、0-9 和 _ ,并以字母开头,例如:header.php API接口 只允许使用 a-z

  • 设备与分区 GRUB2对设备与分区的命名规则举例如下,看看就能明白。需要说明的是磁盘从"0"开始计数,分区从"1"开始计数。 (fd0) 第一软盘 (hd0) 第一硬盘[大多数U盘与USB接口的移动硬盘以及SD卡也都被当作硬盘看待] (hd1,1) 第二硬盘的第一分区(通用于MBR与GPT分区) (hd0,msdos2) 第一硬盘的第二MBR分区,也就是传统的DOS

  • RPM 二进制包的命名需遵守统一的命名规则,用户通过名称就可以直接获取这类包的版本、适用平台等信息。 RPM 二进制包命名的一般格式如下: 包名-版本号-发布次数-发行商-Linux平台-适合的硬件平台-包扩展名 例如,RPM 包的名称是 ,其中: httped:软件包名。这里需要注意,httped 是包名,而 httpd-2.2.15-15.el6.centos.1.i686.rpm 通常称为包

  • 本文向大家介绍PowerShell中对函数参数的命名建议,包括了PowerShell中对函数参数的命名建议的使用技巧和注意事项,需要的朋友参考一下 PowerShell自定义函数的参数没有具体的命名规则,那么怎么做才能让参数的命名更加科学可持续。 我们应该怎么来命名函数的参数名称呢?有没有一个可供参考的列表?当然微软没有给出来。但是我们可以来理一个列表出来。微软自带了大量的cmdlet,这些cmd

  • 介绍完 Linux 系统中目录结构之后,读者一定想知道如何为文件或目录命名。 我们知道,在 Linux 系统中,一切都是文件,既然是文件,就必须要有文件名。同其他系统相比,Linux 操作系统对文件或目录命名的要求相对比较宽松。 Linux 系统中,文件和目录的命名规则如下: 除了字符“/”之外,所有的字符都可以使用,但是要注意,在目录名或文件名中,使用某些特殊字符并不是明智之举。例如,在命名时应