你如何设定主要和次要评论的风格?

Jer*_*ten 7 comments coding-style

有时我想写一个"主要"注释来描述一大块代码,然后编写"次要"注释来描述该代码块中的一些行:

// Major comment

// Minor comment
...

// Minor comment 2
...
Run Code Online (Sandbox Code Playgroud)

主要评论看起来很奇怪,没有代码直接在它下面,你无法直观地告诉它下面描述了多少代码.

你如何设计这些评论?

(我记得很久以前在Code Complete中读到过这个,但我没有这本书.)

Mar*_*ski 1

我使用类似的东西,使其看起来更像以下代码块的“标题”或分隔符:

// ***** Major comment *****

// Minor comment
...

// Minor comment 2
...
Run Code Online (Sandbox Code Playgroud)

当然,这是假设“主要评论”只是几句话