![\"\"](\"https:\/\/www.atlanta247.com\/blog\/wp-content\/uploads\/2019\/01\/poundsign-1.png\")
<\/figure><\/div>\n\n\n\nIn Powershell one can use the # symbol (Pound or Hashtag) to denote information that is “notes” and not part of the code. <\/p>\n\n\n\n
For example I will denote section headers with large blocks of # signs for visibility:
<\/p>\n\n\n\n
\n\n############################################
#
# This section is about commenting your code
#
############################################<\/p>\n\n\n\n
and smaller notes with a smaller comment:<\/p>\n\n\n\n
####################
## Loop through this <\/p>\n\n\n\n
You can also add a # at the end to comment out a piece – for example if I use a whatif for testing but don’t want it there once the code is “production”. <\/p>\n\n\n\n
$user = Get-Aduser -name $inputname #-whatif\n\n<\/p>\n\n\n\n
NOTE: Whereever the #starts, the code ends. <\/p>\n\n\n\n
In additon you can use a “Regions” to denote sections of your code. Like college football conferences… but with less gerrymandering. <\/p>\n\n\n\n
![\"\"](\"https:\/\/www.atlanta247.com\/blog\/wp-content\/uploads\/2019\/01\/fbs-conferences.jpg\")
<\/figure><\/div>\n\n\n\nTo do this we use the # sign and the word “region” followed by a description to start the section: <\/p>\n\n\n\n
#region Our Variables<\/p>\n\n\n\n
And then # and “endregion” to end the section. <\/p>\n\n\n\n
#endregion<\/p>\n\n\n\n
Most powershell editors, like PowerGui Script editor, will then allow you to collapse the region – makes browsing over sections of code:<\/p>\n\n\n\n <\/p>\n\n\n\n I hope you find this useful. <\/p>\n","protected":false},"excerpt":{"rendered":" There is nothing more frustrating than looking at Powershell code from someone else – who didn’t bother to comment the code. 1000 lines without a clue of what is happening, unless you understand the relevance of each command in context. Uhg. In Powershell one can use the # symbol (Pound or Hashtag) to denote information … Continue reading Commenting your Code<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[8],"tags":[],"class_list":["post-122","post","type-post","status-publish","format-standard","hentry","category-powershell"],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/www.atlanta247.com\/blog\/wp-json\/wp\/v2\/posts\/122","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.atlanta247.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.atlanta247.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.atlanta247.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.atlanta247.com\/blog\/wp-json\/wp\/v2\/comments?post=122"}],"version-history":[{"count":1,"href":"https:\/\/www.atlanta247.com\/blog\/wp-json\/wp\/v2\/posts\/122\/revisions"}],"predecessor-version":[{"id":127,"href":"https:\/\/www.atlanta247.com\/blog\/wp-json\/wp\/v2\/posts\/122\/revisions\/127"}],"wp:attachment":[{"href":"https:\/\/www.atlanta247.com\/blog\/wp-json\/wp\/v2\/media?parent=122"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.atlanta247.com\/blog\/wp-json\/wp\/v2\/categories?post=122"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.atlanta247.com\/blog\/wp-json\/wp\/v2\/tags?post=122"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}![\"\"](\"https:\/\/www.atlanta247.com\/blog\/wp-content\/uploads\/2019\/01\/regions.png\")
<\/figure>\n\n\n\n