Last active
October 1, 2017 19:38
-
-
Save Alan-FGR/9b1191395efaf37c60bde1761681f674 to your computer and use it in GitHub Desktop.
Better code comments for C#
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Current way has some cool features, but nobody uses them, and SNR is terrible, plus XML is terribly bad too: | |
/// <summary> | |
/// Function summary goes here | |
/// </summary> | |
/// <param name="param1">Some <i>crazy</i> number</param> | |
/// <param name="param2">Some <b>bad</b> string</param> | |
/// <param name="param3">An amazingly nice value</param> | |
/// <returns>Function returns <see cref="SomeClassType"/></returns> | |
Proposed new way (to be revised) has excellent SNR, is simple and concise: | |
/// Function summary goes here | |
/// param1: Some _crazy_ number | |
/// param2: Some *bad* string | |
/// param3: An amazingly nice value | |
/// returns: Function returns @SomeClassType | |
Revisions/sugestions are welcome. Once we have something good we'll discuss editor plugins. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Stick to md? I personally don't like
[](SomeType)
, and considering that the vast majority of 'links' will be just refing types, that's overkill, we better go with some tags to wrap our stuff, or maybe even some special character to mark the beginning of a type since it can't contain spaces anyway, maybe something likethis method returns @SomeType class etc.