[Grouptime-developers] final comments

[Lucas R. <lu...@uf...>]

Hi all! Here are my final comments about the coding standards.

-------------

In section 2.1 at the include/require/require_once/include_once explanation topic at line 2
it should be: 
"When unconditional includings are needed, require_once() should be used. 
When conditional includings are needed, then include_once() should be used."

Instead of:

"When the unconditional including needed, the require_once() should be used, 
when the conditional including needed, then include_once() should be used."

-------------

Still at section 2.1 at the html explanation topic last line. It should be: 
"For designing the templates, CSS should be used:"

Instead of:

"For designing the template the CSS should be used:"

-------------

Section 2.1 (yet!) at simple boolean expression topic. Is should be:
"ternary operator can be used for simple boolean expressions as following, but when the 
expression is more complicated, all the other necessary standards should be used:"

Instead of:

"simple boolean expressions can be written as following, but when the 
expression is complicated all the other necessary standards should be used: "

-------------

Section 2.2 the inicial text:
"In order to understand quickly the content of the directory structure, what some file
 might contain, we've made a simple file naming standard."

Instead of: 

"In order to understand quickly when looking the directory structure, what some file 
might contain, we've made a little file naming standard."

-------------

Section 2.3, class names:
"class names should match its file name without the '.class.php' sufix."

Instead of:

"class names should match it's file-based name without '_': MyClass.php."

-------------

Section 2.4 first topic should be:
"all the files, functions, classes and their methods should be commented so properly that
 even the developers, who are not familiar to the code, can easily understand and contribute."

Instead of:

"all the files, functions, classes and their methods should be commented so properly that 
even the developers, who is not familiar the code, can easily understand and make a contribution."

--------------

Some "really" final comments: :-)
- Theres nothing about how to name variables that are passed via POST or GET. Do you think this important?
- I think we could add a last section that would give some practical information about who he/she can contact
to get more information.
- I think the docs should be distributed in pdf format because its pratical for printing and reading. The formats
could be rtf, pdf, html e txt. What do you think? The format conversions are very simples in this case.

Thats all!

p eace

--lucasr