[T6A1][T09-B2] Dana Baghabrah #523
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nirandiw
reviewed
Mar 8, 2017
|
|
||
|
|
||
| /** | ||
| * Represents the interface between Storagefile and logic in the address book. |
There was a problem hiding this comment.
Try to give a more general header comment. Tomorrow it could be the interface between two different classes. Generally, we don't refer the subclasses in the super class because it changes over time.
|
|
||
| public abstract class Storage { | ||
|
|
||
| public abstract void save(AddressBook addressBook) throws Exception; |
There was a problem hiding this comment.
Methods should have header comments. If not, developers who need to inherit from this class will not know how exactly they should override the methods and other developers who write client code for this class will not know how to use it either.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ready for review