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),本文就介绍这么多,希望对您有所帮助,谢谢!

时间: 2024-09-27 17:15:28

PowerShell编程中的一些命名规则参考_PowerShell的相关文章

楼宇市场管理+摊位管理中的编号命名规则

问题描述 楼宇市场管理+摊位管理中的编号命名规则 40C 我需要做一个场地管理的,但是想把场地的ID命名的规范一些 ,问一下有什么标准可以参考. 解决方案 上网上搜一下好像有我以前看到过的. 解决方案二: 问题是没有啊 就是摊位的编号规则 还有楼宇的房间编号规则

ios-关于IOS中宏的命名规则

问题描述 关于IOS中宏的命名规则 #define kScreenWidth这里的""k""前缀是什么意思? 解决方案 ""k""前缀代表""常数"" 解决方案二: 其实宏命名常数的时候可以不写前面的k,这个看个人喜好

PowerShell命令中包含空格如何运行?_PowerShell

在PowerShell中,可以直接运行命令.包括.exe结尾的..com结尾的可执行程序,包括.bat结尾的..cmd结尾的批处理程序,还有.vbs结尾的..ps1结尾的脚本程序.均可以使用如下方式运行程序: <程序文件名>.<后缀> [参数列表] 但是请注意,这里的<程序文件名>其实是指的一个路径,可以是相对的,也可以是绝对的.当我们使用绝对路径的时候,会遇到路径中带空格的情况,像上面那种去执行它,就会报错了. 那么,如何运行带空格的命令呢? 答案是用引号!双引号.单

PowerShell函数中使用必选参数实例_PowerShell

本文介绍在PowerShell创建自定义函数时,如何添加必选参数,可以使用Mandatory关键词. 默认情况下,PowerShell自定义的函数中,参数都是可选的(optional).如果要将一个参数设置为必选参数,那么必须对其设置Mandatory声明. 复制代码 代码如下: function Test-Function {     param(         [Parameter(Mandatory=$true)]         $p1,         $p2='p2'     )

Powershell脚本中包含文件资源的例子_PowerShell

Powershell3.0及以后版本. 如果你的脚本需要添加额外资源,比如文本中的服务器名.图片名等等,这时你需要考虑脚本的灵活性. 不要使用绝对路径去指派你的资源路径,在Powershell3.0中可以使用$PSScriptRoot替代你的脚本路径(不支持2.0) 复制代码 代码如下: $picture = "$PSScriptRoot\Resources\picture.png" Test-Path -Path $picture   $data = "$PSScriptR

PowerShell脚本中查看网卡的高级属性_PowerShell

复制代码 代码如下: PS>  Get-NetAdapterBinding  -Name 以太网 | Get-NetAdapterAdvancedProperty Name   DisplayName              DisplayValue        RegistryKeyword            RegistryValue ----   -----------              ------------        ---------------        

css命名规则:图片切图转网页的代码规范

文章简介:网页切图过程中div+css命名规则. 网上整理的比较好的css命名规则,为css代码的规范化做参考,增加代码的可读性. id的命名: (1)页面结构 容器: container 页头:header 内容:content/container 页面主体:main 页尾:footer 导航:nav 侧栏:sidebar 栏目:column 左右中:left right center 页面外围控制整体布局宽度:wrapper (2)导航 导航:nav 主导航:mainbav 子导航:subn

php编程命名规则

编程 命名是程序规划的核心.古人相信只要知道一个人真正的名字就会获得凌驾于那个人之上的不可思议的力 量.只要你给事物想到正确的名字,就会给你以及后来的人带来比代码更强的力量.别笑! 名字就是事物在它所处的生态环境中一个长久而深远的结果.总的来说,只有了解系统的程序员才能为系 统取出最合适的名字.如果所有的命名都与其自然相适合,则关系清晰,含义可以推导得出,一般人的推 想也能在意料之中. 如果你发觉你的命名只有少量能和其对应事物相匹配的话, 最好还是重新好好再看看你的设计吧. 类命名 在为类(cl

ASP中,常用的变量命名规则

变量 在ASP编程中,如果你遵守了下面的变量命名规则,你的代码的可行性.可维护性将会更好: 一般命名规则前缀 变量类型 例子 b or bln Boolean bSuccess c or cur Currency cAmount d or dbl Double dblQuantity dt or dat Date and Time dtDate f or flt Float fRatio l or lng Long lMilliseconds i or int Integer iCounter