tidy-html5/CODESTYLE.md

# HTML Tidy Code Style

The source code of **libTidy**, and console app **tidy**, follow the preferences of the original maintainers. Perhaps some of these decisions were arbitrary and based on their sense of aesthetics at the time, but it is good to have all the code looking the same even if it is not exactly what everyone would prefer.

Developers adding code to **Tidy!** are urged to try to follow the existing code style. Code that does not follow these conventions may be accepted, but may be modified as time goes by to best fit the `Tidy Style`.

There has been a suggestion of using available utilities to make the style consistent, like [Uncrusty](https://github/bengardener/uncrusty) - see [issue #245](https://github.com/htacg/tidy-html5/issues/245), and maybe others...

Others have suggested the [AStyle](http://astyle.sourceforge.net/) formatting program with say  '-taOHUKk3 -M8' arguments, to conform, but there are a few bugs in AStyle.

But again these, and other tools, may not produce code that everybody agrees with... and are presently not formally used in Tidy!

#### Known Conventions

From reading of the Tidy source, some things are self evident... in no particular order...

 - Use of 4-space indenting, and no tabs.
 - No C++ single line comments using `//`.
 - The openning `{` is indented on the next newline.
 - While the maximum code line length varies, generally long `if`, `while`, ... statements are wrapped to newlines.

Look forward to this document being filled out in detail...

Date: 20150904

; eof
Begin some notes on Tidy code style 2015-09-04 13:47:46 +00:00			`# HTML Tidy Code Style`

Some tweaks to CODESTYLE.md 2015-09-04 14:16:24 +00:00			`The source code of libTidy, and console app tidy, follow the preferences of the original maintainers. Perhaps some of these decisions were arbitrary and based on their sense of aesthetics at the time, but it is good to have all the code looking the same even if it is not exactly what everyone would prefer.`
Begin some notes on Tidy code style 2015-09-04 13:47:46 +00:00
Some tweaks to CODESTYLE.md 2015-09-04 14:16:24 +00:00			Developers adding code to Tidy! are urged to try to follow the existing code style. Code that does not follow these conventions may be accepted, but may be modified as time goes by to best fit the `Tidy Style`.
Begin some notes on Tidy code style 2015-09-04 13:47:46 +00:00
Oops issue refs not automatically expanded in md docs 2015-09-04 14:20:12 +00:00			`There has been a suggestion of using available utilities to make the style consistent, like [Uncrusty](https://github/bengardener/uncrusty) - see [issue #245](https://github.com/htacg/tidy-html5/issues/245), and maybe others...`
Begin some notes on Tidy code style 2015-09-04 13:47:46 +00:00
correct speliling in CODESTYLE.md 2015-09-04 13:52:12 +00:00			`Others have suggested the [AStyle](http://astyle.sourceforge.net/) formatting program with say '-taOHUKk3 -M8' arguments, to conform, but there are a few bugs in AStyle.`
Begin some notes on Tidy code style 2015-09-04 13:47:46 +00:00
correct speliling in CODESTYLE.md 2015-09-04 13:52:12 +00:00			`But again these, and other tools, may not produce code that everybody agrees with... and are presently not formally used in Tidy!`
Begin some notes on Tidy code style 2015-09-04 13:47:46 +00:00
			`#### Known Conventions`

			`From reading of the Tidy source, some things are self evident... in no particular order...`

			`- Use of 4-space indenting, and no tabs.`
			- No C++ single line comments using `//`.
			- The openning `{` is indented on the next newline.
			- While the maximum code line length varies, generally long `if`, `while`, ... statements are wrapped to newlines.

			`Look forward to this document being filled out in detail...`

			`Date: 20150904`

			`; eof`