Feature/add use relationship #3
Conversation
…a-php-plugin to 0.0.9
|
Thank you very much for the contribution. We will review it in August. |
There was a problem hiding this comment.
First of all, thank you for your contribution! We really appreciate it :)
There are a few changes that are not written by you. Still, as I did not work on this plugin before, I commented everything I saw.
A few tips in general:
Only add documentation if it adds value to the code. There is no use in adding boilerplate which makes code harder to read. The concept 'Clean Code' states that code should be as self explanatory as possible. Of course, this is not always possible. In this case I can give you two hints:
- Try using more private functions which have exactly one responsibility and name them accordingly.
- Take a lot of time to think about the method naming. Naming is one of the hardest things in software development. I usually rename my code 2-3 times after the first approach.
Please feel free to ask question regarding any of my comments!
| @Property("lineNumber") | ||
| int getLineNumber(); | ||
| void setLineNumber(int lineNumber); | ||
| @Property("firstLineNumber") |
There was a problem hiding this comment.
Thank you for the improvement. That is way clearer than before :)
After improving the property name, the documentation does not add any value - it's redundant. Please remove it.
| @@ -1,19 +1,13 @@ | |||
| import java.io.File; | |||
| import java.io.InputStream; | |||
|
|
|||
| /* | |||
There was a problem hiding this comment.
I didn't work on this plugin before. Is there a good reason to keep this file? Otherwise feel free to remove it.
| @@ -17,6 +17,10 @@ | |||
| @Label(value = "Namespace", usingIndexedPropertyOf = FullQualifiedNameDescriptor.class) | |||
| public interface PHPNamespaceDescriptor extends PHPDescriptor, FullQualifiedNameDescriptor { | |||
|
|
|||
| /** | |||
| @@ -15,6 +15,10 @@ | |||
| @Label("Field") | |||
| public interface PHPPropertyDescriptor extends PHPDescriptor { | |||
|
|
|||
| /** | |||
| @@ -34,6 +38,14 @@ | |||
| Boolean isStatic(); | |||
| void setStatic(Boolean s); | |||
|
|
|||
| /** | |||
| @@ -42,8 +42,8 @@ public PHPPropertyDescriptor parse(ParseTree tree){ | |||
| */ | |||
| protected void parseTree(ParseTree tree, int level){ | |||
|
|
|||
| //String pad = "PPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPP".substring(0, level); | |||
| //System.err.println(pad + " [" + tree.getClass().getSimpleName() + "]: " + tree.getText()); //getCanonicalName | |||
| // String pad = "PPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPP".substring(0, level); | |||
| @@ -50,8 +49,8 @@ public PHPTypeDescriptor parse(ParseTree tree){ | |||
| */ | |||
| protected void parseTree(ParseTree tree, int level, int idx){ | |||
|
|
|||
| //String pad = "CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC".substring(0, level); | |||
| //System.err.println(pad + " [" + tree.getClass().getSimpleName() + "]: " + tree.getText()); //getCanonicalName | |||
| // String pad = "CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC".substring(0, level); | |||
| @@ -16,7 +17,11 @@ | |||
| public String name = ""; | |||
| public String alias = ""; | |||
|
|
|||
| public String getFullQualifiedName(){ | |||
| /** | |||
There was a problem hiding this comment.
This documentation does not provide any value.
| @@ -15,11 +15,18 @@ | |||
| @Label("Parameter") | |||
| public interface PHPFunctionParameterDescriptor extends PHPDescriptor{ | |||
|
|
|||
| /** | |||
There was a problem hiding this comment.
This documentation does not provide value.
| void setIndex(int index); | ||
|
|
||
| /** |
There was a problem hiding this comment.
This documentation does not provide value.
No description provided.