about_Hidden

  • 项目

简短说明

介绍 hidden 关键字，该关键字在默认的 Get-Member 结果中隐藏类成员。

长说明

在脚本中使用 hidden 关键字时，默认会隐藏类的成员。 隐藏的成员不会显示在默认的 Get-Member cmdlet、IntelliSense 或 Tab 键补全结果中。 若要显示使用 hidden 关键字隐藏的成员，请将 Force 参数添加到 Get-Member 命令中。

hidden 关键字可以隐藏：

  • 方法（包括构造函数）
  • 活动
  • 别名属性
  • 其他成员类型（包括静态成员）

隐藏的成员不会显示在 Tab 键补全或 IntelliSense 中，除非补全发生在定义隐藏成员的类中。

新属性 System.Management.Automation.HiddenAttribute 使 C# 代码能够在 PowerShell 中使用相同的语义。

要在类中创建你不一定希望类用户看到或能够随时编辑的属性和方法，可以使用 hidden 关键字。

hidden 关键字对查看或更改类成员的方式没有影响。 与 PowerShell 中的所有语言关键字一样，hidden 不区分大小写，并且隐藏的成员仍然是公开的。

Windows PowerShell 5.0 中引入了 hidden 关键字和自定义类。

示例

以下示例演示如何在类定义中使用 hidden 关键字。 Car 类方法 Drive 有一个属性 rides，无需查看或更改此属性，因为它仅记录针对 Car 类调用 Drive 的次数。 该指标对于类用户而言并不重要（例如，当你购买汽车时，你不会询问销售员该汽车已行驶了多少次）。

由于类用户几乎不需要更改此属性，因此我们可以使用 hidden 关键字对 Get-Member 和自动补全结果隐藏该属性。

在属性及其数据类型所在的同一语句行中输入 hidden 关键字即可添加该关键字。 尽管该行中的关键字可以采用任意顺序，但以 hidden 关键字开头的语句可让你以后更轻松地识别隐藏的所有成员。

class Car
{
   # Properties
   [String] $Color
   [String] $ModelYear
   [int] $Distance

   # Method
   [int] Drive ([int]$miles)
   {
      $this.Distance += $miles
      $this.rides++
      return $this.Distance
   }

   # Hidden property of the Drive method
    hidden [int] $rides = 0
}

现在创建 Car 类的新实例，并将其保存在变量 $TestCar 中。

$TestCar = [Car]::new()

创建新实例后，通过管道将 $TestCar 变量的内容传递给 Get-Member。 请注意，rides 属性不属于 Get-Member 命令结果中列出的成员。

PS C:\Windows\system32> $TestCar | Get-Member

   TypeName: Car

Name        MemberType Definition
----        ---------- ----------
Drive       Method     int Drive(int miles)
Equals      Method     bool Equals(System.Object obj)
GetHashCode Method     int GetHashCode()
GetType     Method     type GetType()
ToString    Method     string ToString()
Color       Property   string Color {get;set;}
Distance    Property   int Distance {get;set;}
ModelYear   Property   string ModelYear {get;set;}

现在再次尝试运行 Get-Member，但这次请添加 -Force 参数。 请注意，结果包含隐藏的 rides 属性以及默认隐藏的其他成员。

PS C:\Windows\system32> $TestCar | Get-Member -Force

   TypeName: Car

Name          MemberType   Definition
----          ----------   ----------
pstypenames   CodeProperty System.Collections.ObjectModel.Collection`1
psadapted     MemberSet    psadapted {Color, ModelYear, Distance,
psbase        MemberSet    psbase {Color, ModelYear, Distance,...
psextended    MemberSet    psextended {}
psobject      MemberSet    psobject {BaseObject, Members,...
Drive         Method       int Drive(int miles)
Equals        Method       bool Equals(System.Object obj)
GetHashCode   Method       int GetHashCode()
GetType       Method       type GetType()
get_Color     Method       string get_Color()
get_Distance  Method       int get_Distance()
get_ModelYear Method       string get_ModelYear()
get_rides     Method       int get_rides()
set_Color     Method       void set_Color(string )
set_Distance  Method       void set_Distance(int )
set_ModelYear Method       void set_ModelYear(string )
set_rides     Method       void set_rides(int )
ToString      Method       string ToString()
Color         Property     string Color {get;set;}
Distance      Property     int Distance {get;set;}
ModelYear     Property     string ModelYear {get;set;}
rides         Property     int rides {get;set;}

另请参阅