Menu

#5 Improve IDE documentation

1.0
accepted
Nick
2013-03-13
2013-02-20
Nick
No

Improve documentation in IDE projects: add minimum explanations where required.

Discussion

  • Nick

    Nick - 2013-03-12

    Guys, attention!

    if you write something like this

    ///


    /// Input Parameter: Synapses with permanences above this value are connected.
    ///

    int connectedPerm;
    public int ConnectedPermanence
    {
    get { return connectedPerm; }
    set
    {
    this.connectedPerm = value
    }
    }

    the summary isn't applied to the public property and can't be seen as its documentation, so please try to make it like this

    int connectedPerm;

    ///


    /// Input Parameter: Synapses with permanences above this value are connected.
    ///

    public int ConnectedPermanence
    {
    get { return connectedPerm; }
    set
    {
    this.connectedPerm = value
    }
    }

     
    • David Ragazzi

      David Ragazzi - 2013-03-18

      Thanks for the tip! I really didn't know about this.

       

      Last edit: David Ragazzi 2013-03-18
MongoDB Logo MongoDB