3 Replies Last post: Feb 3, 2013 1:04 AM by Andriy Bazanov  
Stephan Krauß Novice 108 posts since
May 30, 2011
Currently Being Moderated

Feb 1, 2013 7:15 PM

Inline comments

Hello!

I document my scripts with the PhpDocumentor.
In some methods I have inline comments.
Can I invest in the Javadoc comment block adopt these comments automatically.

Sincerely yours

Stephan

Maxim Makhankov JetBrains 61 posts since
May 31, 2012
Currently Being Moderated
Feb 1, 2013 7:28 PM in response to: Stephan Krauß
Re: Inline comments

Stephan, could you please provide the examples of code: what you have and what you'd like to have?

Andriy Bazanov Master 2,645 posts since
May 28, 2010
Currently Being Moderated
Feb 3, 2013 1:04 AM in response to: Stephan Krauß
Re: Inline comments

Hi Stephan,

 

If I type / ** Javadoc is the block generated.

It's called PHPDoc in PHP world -- http://www.phpdoc.org/docs/latest/index.html

 

Is it possible to take the inline comments automatically?

No -- such functionality is not currently present in PhpStorm.

 

Considering that "proper guys" would normally write some comments to explain some moments in their code ... such approach (to add these comment into method PHPDoc comment) would be overkill (unless configurable, of course). So far I have not seen any open source project/librarys that would use it.

More Like This

  • Retrieving data ...