brson and the Style Guide seem to favour stacked line comments: https://github.com/mozilla/rust/wiki/Note-style-guide#comments
"Reason: it avoids the debate about whether to put stars on every line, etc." is an important point. I was trying to standardise std::num to style C when I was working on it. I would be happy if A and B were removed. /* */ is still useful for commenting out code though, but not for doc comments. ~Brendan On 26/08/2013, at 11:59 AM, Corey Richardson <co...@octayn.net> wrote: > Currently there are a few conventions throughout the codebase, and I > think we need to agree which one to use, at least in the stdlib and > compilers. This email is the result of me needing to encode some > heuristics in rustdoc_ng to strip out the comments and keep the text. > > So the major conventions I've seen are: > > A: > > /*! Summary > > Body text > > */ > > B: > > /** > * Summary > * > * Body text > */ > > C: > > //! Summary > //! > //! Body text > > Of course, /*! and //! are interchangable with /** and ///. Now, I > don't particularly care which one gets picked (B is my favorite for > longer blocks, C for <= 3 lines), and I especially dislike A, but > consistency is king. > _______________________________________________ > Rust-dev mailing list > Rust-dev@mozilla.org > https://mail.mozilla.org/listinfo/rust-dev _______________________________________________ Rust-dev mailing list Rust-dev@mozilla.org https://mail.mozilla.org/listinfo/rust-dev
