Skip to content
This repository has been archived by the owner on Jul 22, 2019. It is now read-only.

Support PHPDoc comments #12

Open
6 tasks done
nevadascout opened this issue Apr 9, 2016 · 4 comments
Open
6 tasks done

Support PHPDoc comments #12

nevadascout opened this issue Apr 9, 2016 · 4 comments

Comments

@nevadascout
Copy link
Member

nevadascout commented Apr 9, 2016

PHPDoc comments on methods, properties, etc should be displayed in the intellisense as extra information.

This feature depends on php-parser adding support for comments.

Type hinting should be included:

/**
 * @var string
 */
$test = "test";

Update the treebuilder to store the last doc comment that we find, and then if symbol definition, check the doc comment is the line above the symbol and apply information as required.

  • Description/summary
  • @var
  • @param
  • @return
  • @throws
  • @deprecated

This first pass will enable code completion to use the phpdoc comment typings, but only on top level variables.

Eg.

/** @var SomeClass */
$test = $otherObject;
$test->
//      ^ works here

$test->prop->
//            ^ won't work here yet
@michalhudecek
Copy link

Any ETA on this feature? It would be awesome to have it!

@nevadascout
Copy link
Member Author

@michalhudecek Not sure yet, parsing of phpdoc comments has to be added to the parser library that we are using before we can actually add this.

@michalhudecek
Copy link

Anything I can do to speed it up?

@nevadascout
Copy link
Member Author

Contributing to Glayzzle's php-parser project would help us tremendously!

@nevadascout nevadascout added this to the 0.3.4 milestone Mar 4, 2017
@nevadascout nevadascout modified the milestones: 0.3.3, 0.7.0 Mar 11, 2017
@nevadascout nevadascout modified the milestones: 0.3.4, 0.3.3 Mar 11, 2017
@nevadascout nevadascout modified the milestones: 0.3.5, 0.3.4, 0.3.6 Mar 20, 2017
@Jeffbreno Jeffbreno mentioned this issue Jun 15, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants