Submission protocol

作者: osgChina 發布于2018-10-30 14:55:29 分類 : 提交協議

Use this page to record corrections to common spelling and grammatical mistakes. This will make sure our changes are consistent.

  • Doxygen-edible, multi-line comment style:

/** A slash, followed by two asterisks and a space, followed
  * by a capital letter as the start of a sentence. Subsequent
  * lines start with two spaces, an asterisk, a space, then
  * text. The final line is an asterisk and a slash.
 */

Doxygen-edible Single-line comment style: A slash, two asterisks, a space, a complete sentence with capitalization ending with a period, a space, an asterisk, and a slash.

/** This is a single-line Doxygen comment. */

The C++ form is acceptable for non-Doxygen comments:

// A C++ comment.

Plural versus possessive: parameters -- plural, more than one parameter. parameter's -- possessive form of a single parameter. parameters' -- possessive form of multiple parameters.

"its" versus "it's" its -- Possessive. it's -- contraction form of "it is".

Separate not seperate.

Equivalent not equivalant.

OpenGL not OpenGl

Color not colour

Mipmap not mip map

"OpenSceneGraph" not "The OpenSceneGraph"

Try to fit in 80 Columns ?

Tabs are 4 spaces

Remove extraneous whitespace at end of lines, wherever noticed

Condense multiple spaces between sentences: good starting place.  The OSG's to
good starting place. The OSG's

Common fragments that could be batch replaced

/** Accept an ConstAttributeFunctor

to

/** Accept a ConstAttributeFunctor

* Capitalize first letter and insert an extra space preceeding the */ at the end of these common blocks (can be automated):

/** copy constructor using CopyOp to manage deep vs shallow copy.*/
/** return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.*/

? 千炮捕鱼联网版赢话费 山西11选5走势图 炒股六句口诀 百度一下 黑龙江22选5奖池 快乐8稳拿888a。me真诚 七位数彩票怎么算中奖 香港管家婆四??像 排列五杀号定胆100%准 怎样分析股市行情 湖北快三形态走势图一 北京时时彩赛车 上海时时乐电脑版开走势图 河南快三走势图近200 江苏快三带连走势图 股票指数衍生工具 浙江6+1开奖结果19084 上海快三开奖结果查询