Commenting for documentation generation

Documenting your source code is always a good idea. It helps other developers to understand the code and eases code adoption and maintenance.

It is always a good idea to include copyright notices at the top of each source code file and to comment on your namespaces, interfaces, classes, enums, structs, methods, and properties. Your copyright comments should be first in the source file, above the using statements, and take the form of a multiline comment that starts with /* and ends with */:

/*********************************************************** Copyright 2019 PacktPub
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
* Software, and to permit persons...