Verb-Noun naming convention in PowerShell - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the Verb-Noun naming convention in PowerShell?

It is a way to name commands where the name starts with a verb followed by a noun, like Get-Process. This makes commands easy to understand and consistent.

beginner

Why use the Verb-Noun naming convention in PowerShell scripts?

It helps keep scripts clear and predictable. When you see a command like Set-Item, you know it changes something. This makes scripts easier to read and maintain.

beginner

Give an example of a correct Verb-Noun command name in PowerShell.

An example is Remove-User. Remove is the action (verb), and User is the object (noun).

intermediate

What is a common mistake when naming PowerShell commands?

Using names without a clear verb or noun, like ProcessData or just Data. This makes it hard to know what the command does.

beginner

Name three approved verbs commonly used in PowerShell command names.

Common approved verbs include Get, Set, and Remove. These verbs clearly describe actions.

Which of these is a correct Verb-Noun PowerShell command name?

A RunServiceNow

B Start-Service

C ServiceStart

D Service_Run

PowerShell commands use a verb followed by a noun, like Start-Service. The others do not follow this pattern.

What does the verb in a Verb-Noun command name represent?

A The script file name

B The object to work on

C The action to perform

D The output format

The verb shows the action the command will perform, like Get or Set.

Why is it important to use approved verbs in PowerShell command names?

A To keep commands consistent and clear

B To make commands run faster

C To avoid using nouns

D To make commands shorter

Approved verbs keep command names consistent and easy to understand.

Which of these is NOT an approved verb in PowerShell naming?

A Fetch

B Get

C Remove

D Set

Fetch is not an approved verb; Get should be used instead.

What is the noun part in the command New-Item?

A None

B New

C New-Item

D Item

The noun is the object the command works on, here it is Item.

Explain the Verb-Noun naming convention and why it is useful in PowerShell scripting.

Think about how commands like Get-Process or Set-Item are named.

List three approved verbs you can use in PowerShell command names and give an example command for each.

Approved verbs describe common actions in PowerShell.

Practice

1. What does the Verb-Noun naming convention in PowerShell primarily help with?

easy

A. Encrypting scripts for security

B. Shortening command names

C. Adding comments to scripts

D. Making commands clear and consistent

Solution

1. Step 1: Understand the purpose of Verb-Noun naming

   The Verb-Noun style is designed to make commands easy to read and understand by showing the action and the target clearly.

2. Step 2: Identify the main benefit

   This naming style helps users quickly know what a command does, improving clarity and consistency.

3. Final Answer:

   Making commands clear and consistent -> Option D

4. Quick Check:

   Verb-Noun naming = clarity and consistency [OK]

Hint: Verb shows action, noun shows target for clarity [OK]

Common Mistakes:

• Thinking it shortens command names
• Confusing it with script encryption
• Believing it adds comments automatically

2. Which of the following is the correct syntax for a PowerShell function name following the Verb-Noun convention?

easy

A. Get-Process

B. ProcessGet

C. GetProcess

D. process-get

Solution

1. Step 1: Identify the correct Verb-Noun format

   The correct format uses a verb, a dash, then a noun, like 'Get-Process'.

2. Step 2: Compare options

   Only Get-Process uses the dash and proper order; others do not follow the convention.

3. Final Answer:

   Get-Process -> Option A

4. Quick Check:

   Verb-Noun = Verb-Noun with dash [OK]

Hint: Look for verb-noun separated by a dash [OK]

Common Mistakes:

• Omitting the dash between verb and noun
• Reversing noun and verb order
• Using camelCase instead of dash

3. What will be the output of this PowerShell command if you define a function named Set-UserName and call it with Set-UserName -Name 'Alice' assuming the function prints the name parameter?

function Set-UserName { param($Name) Write-Output "User name is $Name" }

medium

A. Error: Unknown command

B. Set-UserName -Name Alice

C. User name is Alice

D. User name is $Name

Solution

1. Step 1: Understand the function definition

   The function takes a parameter called Name and outputs a string including that parameter.

2. Step 2: Analyze the function call

   Calling Set-UserName with -Name 'Alice' passes 'Alice' to the $Name parameter, so the output is 'User name is Alice'.

3. Final Answer:

   User name is Alice -> Option C

4. Quick Check:

   Parameter passed correctly = output with name [OK]

Hint: Parameters passed by name show in output [OK]

Common Mistakes:

• Expecting the command name as output
• Not recognizing variable substitution
• Assuming an error without function definition

4. Identify the error in this PowerShell function name that violates the Verb-Noun naming convention:

function Process-Data { Write-Output "Processing" }

medium

A. Verb should be a standard approved verb

B. Noun should come before verb

C. Missing dash between verb and noun

D. Verb is not approved

Solution

1. Step 1: Check the function name structure

   The name 'Process-Data' uses a dash and has verb-noun order, so structure is correct.

2. Step 2: Verify the verb against approved verbs

   'Process' is not an approved PowerShell verb, so it violates the naming convention.

3. Final Answer:

   Verb should be a standard approved verb -> Option A

4. Quick Check:

   Approved verbs required = Verb should be a standard approved verb [OK]

Hint: Use only approved verbs in function names [OK]

Common Mistakes:

• Thinking noun comes before verb
• Ignoring approved verb list
• Assuming dash is missing

5. You want to create a PowerShell function that deletes temporary files. Which of these names follows the Verb-Noun naming convention correctly and uses an approved verb?

hard

A. Erase-TempFiles

B. Remove-TempFiles

C. Delete-TempFiles

D. ClearTempFiles

Solution

1. Step 1: Identify approved verbs for deleting

   PowerShell approved verbs for deleting include 'Remove' and 'Clear', but 'Delete' and 'Erase' are not approved.

2. Step 2: Check naming format

   Remove-TempFiles uses 'Remove' (approved verb), a dash, and 'TempFiles' (noun), following Verb-Noun convention correctly.

3. Step 3: Evaluate other options

   Erase-TempFiles uses unapproved verb 'Erase', Delete-TempFiles uses unapproved verb 'Delete', and ClearTempFiles lacks dash between verb and noun.

4. Final Answer:

   Remove-TempFiles -> Option B

5. Quick Check:

   Approved verb + dash + noun = Remove-TempFiles [OK]

Hint: Use approved verbs like Remove with dash and noun [OK]

Common Mistakes:

• Using unapproved verbs like Delete or Erase
• Omitting dash between verb and noun
• Combining words without dash