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

所属分类: 脚本专栏 / PowerShell 阅读数: 1383
收藏 0 赞 0 分享

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

更多精彩内容其他人还在看

PowerShell入门教程之高效使用PowerShell交互式运行环境的几个小技巧

这篇文章主要介绍了PowerShell入门教程之高效使用PowerShell交互式运行环境的几个小技巧,本文也可以说是使用PowerShell的一些好习惯,需要的朋友可以参考下
收藏 0 赞 0 分享

PowerShell入门教程之Cmd命令与PowerShell命令相互调用的方法

这篇文章主要介绍了PowerShell入门教程之Cmd命令与PowerShell命令相互调用的方法,本文讲解了在Cmd命令中调用PowerShell命令、在PowerShell命令中调用Cmd命令的方法,需要的朋友可以参考下
收藏 0 赞 0 分享

PowerShell入门教程之远程操作运行PowerShell的方法

这篇文章主要介绍了PowerShell入门教程之远程操作运行PowerShell的方法,本文讲解了配置远程基础结构、执行远程操作等内容,需要的朋友可以参考下
收藏 0 赞 0 分享

PowerShell入门教程之PowerShell管道介绍

这篇文章主要介绍了PowerShell入门教程之PowerShell管道介绍,本文讲解了管道的作用,并列出了几个使用实例,需要的朋友可以参考下
收藏 0 赞 0 分享

PowerShell入门教程之函数、脚本、作用域介绍

这篇文章主要介绍了PowerShell入门教程之函数、脚本、作用域介绍,本文所讲内容都是PowerShell的基础知识,需要的朋友可以参考下
收藏 0 赞 0 分享

PowerShell入门教程之访问.Net程序集、COM和WMI实例

这篇文章主要介绍了PowerShell入门教程之访问.Net程序集、COM和WMI实例,本文讲解了PowerShell作为Windows平台的脱水语言来访问其它资源的例子,需要的朋友可以参考下
收藏 0 赞 0 分享

PowerShell入门教程之创建和使用配置文件实例

这篇文章主要介绍了PowerShell入门教程之创建和使用配置文件实例,PowerShell的配置文件都是些普通的PowerShell脚本文件,需要的朋友可以参考下
收藏 0 赞 0 分享

PowerShell入门教程之编写和使用脚本模块实例

这篇文章主要介绍了PowerShell入门教程之编写和使用脚本模块实例,本文讲解了模块、脚本模块、编写脚本模块、模块安装路径、模块文件夹等内容,需要的朋友可以参考下
收藏 0 赞 0 分享

WMI入门教程之什么是WMI?

这篇文章主要介绍了WMI入门教程之什么是WMI?WMI有一组API,我们可以使用VBScript、PowerShell脚本还是利用C#的来访问WMI的类库,需要的朋友可以参考下
收藏 0 赞 0 分享

WMI入门教程之怎么使用WMI?

这篇文章主要介绍了WMI入门教程之怎么使用WMI?本文讲解了在软件中、PowerShell中、.NET中使用WMI的例子,需要的朋友可以参考下
收藏 0 赞 0 分享
查看更多