admin/PowerShell-PowerShell
1
0
Fork 0
mirror of https://github.com/PowerShell/PowerShell synced 2026-06-08 12:12:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update coding-guidelines to encourage adding code comments (#2489)

Browse Source
This commit is contained in:
Dongbo Wang
2016-10-18 10:12:20 -07:00
committed by Andrew Schwartzmeyer
parent 5e1661df59
commit d26b1d7155
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/dev-process/coding-guidelines.md
+8
View File
@@ -82,3 +82,11 @@ over runtime checks.
We produce a single binary for all UNIX variants,
so runtime checks are currently necessary for some platform differences, e.g. macOS and Linux.
## Code comments
It's strongly encouraged to add comments when you are making changes to the code and tests,
especially when the changes are not trivial or may raise confusion.
Make sure the added comments are accurate and easy to understand.
Good code comments would greatly improve readability of the code, and make it much more maintainable.