|
bether variable documentation |
|
Hi!
Perhaps you are not aware, that the /** ... */ is so called phpDoc syntax (note the two starting * asterisks). It is intended to separate function-related and variable-related comments and some minor in-comment functionalities (like what parameters a function use, what variable type it returns, etc.) from normal comments, which could be either multiline /* ... */ (note the one starting * asterisk) or in-line // ... (starting with two slashes). That's why it shows function or variable description as a tooltip, because the phpDoc syntax allows it. It would not be wise to display all comments, because in general they have no fixed inside syntax. I suggest you to google more information on phpDoc to understand it better, because the phpDoc will add some extra functionalities to the IDE and you can also easily generate documentation automatically with phpDoc tools, if the phpDoc is used properly. The "parsing" of // @todo:bla comment is not really a parsing of the comment, but rather parsing of the whole file in search of special tags like @todo: and @fixme: - the fact that they are often used in comments might be confusing, but you can also put them in the phpDoc /** ... */ syntax. And as for the code length because of the phpDoc comments, there is an option to collapse the comments by default when you open the file in Tools > Settings > Editor > Code Folding > Auto-collapse on open - check this option and you can select to collapse the comments when you open a file. |
||||||||||||
|
bether variable documentation |
|
||
Content © NuSphere Corp., PHP IDE team
Powered by phpBB © phpBB Group, Design by phpBBStyles.com | Styles Database.
Powered by
Powered by phpBB © phpBB Group, Design by phpBBStyles.com | Styles Database.
Powered by