69

What's your excuse?

Comments
  • 13
    The code should be self documenting!!
  • 3
    Docs always become outdated 😜
  • 6
    ///<summary >
    /// How it's used.
    ///</summary>
    void DoStuff()
    {
    // why it's done
    int what = it.Does();
    }
  • 2
    I don't want to lose my job
  • 0
    I program in Ruby
  • 1
    @CWins I was thinking to make a better documentation tool. Like jsdoc:
    // #param name:obj type:object
    And it should generate MSDN-like pages
  • 1
    @CWins won't summary explain "what it does"? Or do you include that in "how it's used"? Or not?
  • 2
    @Alfer
    Of course theres an overlap. I chose "How it is used" because it emphasizes the perspective of the user.

    I think perspective is important when writing documentation. Summary-docs are seen in a tooltipp by dev who use that component, while comments in code are seen by devs who debug/change the code.

    @robzombie111
    While it is true that changes in code can make the comments lie, the reason for change in code are often bugs which means, that the code does not match it's intent and it's hard for the next developer to make code fit the intent, if there is only code.

    A well done summary can tell what a piece of code is intended to do and how it is used.

    I'm all in on good naming and readable code, and comments should not repeat that, but they can add information the code does not and can not give, which is intent and knowledge that is not obvious, like some other API or LIBs behaviour that requires code, that seems suboptimal.
  • 1
  • 0
    @mstrange88 Once you get the hold of it, its not that hard!! Use descriptive method names and be like a storyteller. Something like:

    def replace_username_with(email)
    ...
    End
Add Comment