Code Review notes for Eclipse GReg plugin
- Proper naming of packages, classes and variables
- name of the class CollectionEditor should be changed as
registryResourceEditor
- class RegistryResourcePathData should be renamed as
RegistryResourceNode
- varable name "clone" of RegistryResourcePathData should be changed
to reflect the real need of that
- package name org.wso2.tools.eclipse.greg should be changed into
org.wso2.carbonstudio.eclipse.registry (top level project should
be carbon
studio)
- Add proper comments to make the code more readable and understandable
- Proper exception handling
- Relevant exceptions should be thrown from registry side
- define custom exception types to handle different use-cases
- Break in to small private methods to improve the readability of the
code
- In the addPages method of CollectionEditor class, first check whether
the selected object is a collection or a resource and then check whether it
is a new resource or existing resource
- validate method of CollectionEditor class should return a boolean and
doSave method should be called if the validation is successful
- validate method should also have info on which page is failed
- Should use braces even for single line if-else blocks
- Link with editor option should be a global option
- setError(false) should be stated on the very beginning of the method
getResourcePathList of RegistryResourcePathData class
- Remove the reference for IEditorPart in RegistryResourcePathData class
- Add proper log messages incorporate with carbon studio
- Message dialog pop up when an error is encounted should be changed in
to error dialog
code review notes can be found in
[1]<https://docs.google.com/a/wso2.com/Doc?docid=0AQw66X7HqlFKZGd2Z2RiNWZfNDVmZmZkdHpyeA&hl=en>as
well.
Best regards,
Chathuri
[1]
https://docs.google.com/a/wso2.com/Doc?docid=0AQw66X7HqlFKZGd2Z2RiNWZfNDVmZmZkdHpyeA&hl=en
On Wed, Apr 21, 2010 at 9:49 AM, Saminda Wijeratne <[email protected]>wrote:
> $subject today at 2pm @ upstairs conf. room.
> Find the outline and notes @ [1].
>
> Regards,
> Saminda
>
> [1]
> https://docs.google.com/a/wso2.com/Doc?docid=0AQw66X7HqlFKZGd2Z2RiNWZfNDVmZmZkdHpyeA&hl=en
>
> _______________________________________________
> Carbon-dev mailing list
> [email protected]
> https://mail.wso2.org/cgi-bin/mailman/listinfo/carbon-dev
>
>
_______________________________________________
Carbon-dev mailing list
[email protected]
https://mail.wso2.org/cgi-bin/mailman/listinfo/carbon-dev
