14
Grumpy
8y

Is there anything uglier than XML documentation comments? The signal to noise ratio is appalling, like an exercise in redundancy for the sake of redundancy.

/// <summary>
/// Initializes a new instance of the <see cref="CipherInfo"/> class.
/// </summary>
/// <param name="keySize">Size of the key.</param>
/// <param name="cipher">The cipher.</param>
public CipherInfo(int keySize, Func<byte[], byte[], Cipher> cipher)
{ ... }

Compare that to the equivalent markdown documentation comments:
/// Initializes a new instance of the <see cref="CipherInfo"/> class.
/// ##Parameters
/// - `keySize` - Size of the key.
/// - `cipher` - The cipher.
public CipherInfo(int keySize, Func<byte[], byte[], Cipher> cipher)
{ ... }

Comments
  • 1
    I can think of one thing that's uglier: the entire PHP language.
  • 0
    @zamo i can see that you're attempting to be funny but it's a dead meme now, move on
  • 0
    XML has a ridiculous self-description fetish.
    Its not surprising that its comments are equally ridiculous.
Add Comment