Sometimes it's the little things



  • These aren't new; they're not uncommon; they're not horrible; they're just groan-and-sigh-inducing.

    Here's a submission from the Department Of Why Didn't You Just Name The Method That Then? (note the use of the Devowelizer(tm)):

    /// <summary>
    /// Populates the Lookup Results DataGrid
    /// </summary>
    private void PopLkpRsltsDg()

    And some good ol' pointlessness:

    /// <summary>
    /// Fires when the Upload button is clicked.
    /// </summary>
    /// <param name="sender"></param>
    /// <param name="e"></param>
    protected void btnUpld_Click(object sender, System.EventArgs e)

    And a different sort of "oh boy...":

    /// <summary>
    /// Validate the form. Returns true if form is valid, false if not.
    /// </summary>
    private bool ValFrm()



  •  

    Do they get paid per line?



  • The real wtf is the weird XML-based commenting system.



  • [quote user="bugmenot"]The real wtf is the weird XML-based commenting system.
    [/quote]

    It's JavaDocEE 2.0 



  • [quote user="bugmenot"]The real wtf is the weird XML-based commenting system.
    [/quote]

    That's actually from the Visual Studio IDE.  Apparently there's something like doxygen for C# code which turns those XML comments into a .CHM file much like the built-in help.



  • Type /// into Visual C#.NET, it will generate a doc-comment block for you, similar to the way /** gives you a JavaDoc comment block in IntelliJ.

     Also generates tags for parameters, return values, etcetera.

     
    Can be turned into CHMs, MSDN-style pages, JavaDoc style pages, etc...

    See this screenshot.

     
    *sighs* You see, this is where Intellisense helps. It shows these people a better way, and you don't have to type all those characters (stupid Java... setContentIgnorableWhitespace(...) indeed!)



  • As ugly and spammy and difficult to read as that XML doc system is... it does have one thing going for it.  You're not really tied down to one parser.



  • The real WTF is the resulting page when you've done something wrong in the form:

    "You have made an error somewhere in this form..."



  • Ouch. I do the exact opposite so that one of my VS.Net plugins automatically generates the documentation using its psychic powers.

     

    To put things in perspective, this is what the plugin generated :

    /// <summary>
    /// Pops the LKP RSLTS dg.
    /// </summary>
    private void PopLkpRsltsDg()



    /// <summary>
    /// Handles the Click event of the btnUpld control.
    /// </summary>
    /// <param name="sender">The source of the event.</param>
    /// <param name="e">The <see cref="System.EventArgs"/> instance containing the event data.</param>
    protected void btnUpld_Click(object sender, System.EventArgs e)




    /// <summary>
    /// Vals the FRM.
    /// </summary>
    /// <returns></returns>
    private bool ValFrm()

Log in to reply
 

Looks like your connection to What the Daily WTF? was lost, please wait while we try to reconnect.