导出模块变量名称的命名约定
Naming convention for exported module variable names
我想重复使用模块中的一个变量。假设它是一个常数。
#MyModule.psm1
$MyVar = randomObject
Export-ModuleMember -Variable MyVar
#Get-Stuff.ps1
Import-Module -Name $moduleName
$randomVar = $MyVar.Property
我的意思是,我可以只使用常规约定,但编码人员怎么知道这个变量是从导入的模块实例化的?
在我的意见中,您可能一开始就不应该导出变量。到目前为止,我还没有看到这样做的令人信服的理由。
相反,我宁愿导出一个函数,即使它只是 return 单个对象。它更安全、更通用、更明显等等
但是导入您的模块的人将不得不通过阅读您的文档或只是熟悉它来了解它。还不如看导出函数那么简单
如果您担心名称冲突,您在命名变量时有很大的自由度,特别是如果您想让它很难被引用:
${Some really ___ weird um, variable n@m3} = randomObject
我想重复使用模块中的一个变量。假设它是一个常数。
#MyModule.psm1
$MyVar = randomObject
Export-ModuleMember -Variable MyVar
#Get-Stuff.ps1
Import-Module -Name $moduleName
$randomVar = $MyVar.Property
我的意思是,我可以只使用常规约定,但编码人员怎么知道这个变量是从导入的模块实例化的?
在我的意见中,您可能一开始就不应该导出变量。到目前为止,我还没有看到这样做的令人信服的理由。
相反,我宁愿导出一个函数,即使它只是 return 单个对象。它更安全、更通用、更明显等等
但是导入您的模块的人将不得不通过阅读您的文档或只是熟悉它来了解它。还不如看导出函数那么简单
如果您担心名称冲突,您在命名变量时有很大的自由度,特别是如果您想让它很难被引用:
${Some really ___ weird um, variable n@m3} = randomObject