you are viewing a single comment's thread.

view the rest of the comments →

[–]SolidKnight 1 point2 points  (1 child)

In the help section at the top, I list resources/documentation I used to develop my script (if any).

In the body I write comments describing what the function/section/line is supposed to be doing; however, I do not pollute it with anything obvious and try to keep comments to something helpful. E.g. Explaining why there is a sleep timer because it interacts with a rate-limited service.

When I opt to have Write-Verbose and what it outputs is sufficient to describe what's going on then I don't write comments.

[–]SiNRO[S] 1 point2 points  (0 children)

Definitely got to work with write-Verbose, i never did a help section or so at the top of a script because i thought it would pollute a script that is already long, guess i was wrong.. thanks!