Documentation Insight Annual Survey

-
Documentation Insight Annual Survey

https://docs.google.com/spreadsheet/viewform?formkey=dEhxY2FINm41cFJjaEJZdld2SFlod1E6MQ

Comments

  1. Vitali BurkovDecember 28, 2012 at 12:49 AM

    Baoquan Zuo I like doxygen style comments like this:
    /**
     * Splits the node along a given axis.
     * The list of indices is reorganized according to the split values.
     * \param axis [in] splitting axis index
     * \param builder [in] the tree builder
     * \return the number of primitives assigned to the first child
     * \warning this method reorganizes the internal list of primitives
     */

    ReplyDelete
  2. Vitali BurkovDecember 28, 2012 at 1:03 AM

    Or it could be even more minimal, like this:
        function FindSeamPoint(const tv: TIsoCurveVertex; const fc: TST_AFace;
          out sp: TIsoCurveVertex):boolean;
          //Find continuation of the curve on a next face
          //[in] tv bla-bla-bla
          //[in] fc bla-bla-bla
          //[out] sp bla-bla-bla
          //[return] bla-bla-bla

    ReplyDelete
  3. Baoquan ZuoDecember 28, 2012 at 1:46 AM

    Vitali Burkov For inline doc styles, most people prefer javadoc/nativecomment or doxygen. It is just a matter of styles. I definitely agree that DI need to support more styles to adapt to most developers. You might want to see this poll: http://www.devjetsoftware.com/polls/

    ReplyDelete

Post a Comment