2import homomorphic_encryption.HomomorphicEncryption;
3import secure_multi_party_computation.SecureMultiPartyComputation;
4
5public class SidraDataPrivacyPlatform { 6 private HomomorphicEncryption homomorphicEncryption; 7 private SecureMultiPartyComputation secureMultiPartyComputation; 8 9 public SidraDataPrivacyPlatform() {10 homomorphicEncryption = new HomomorphicEncryption();11 secureMultiPartyComputation = new SecureMultiPartyComputation();12 }1314 public byte[] encryptData(byte[] data) {15 return homomorphicEncryption.encrypt(data);16 }1718 public byte[] decryptData(byte[] encryptedData) {19 return homomorphicEncryption.decrypt(encryptedData);20 }2122 public byte[] computeOnEncryptedData(byte[] encryptedData1, byte[] encryptedData2) {23 return secureMultiPartyComputation.compute(encryptedData1, encryptedData2);24 }25}This class does not have any documentation.
Consider adding a documentation comment to explain its use.
While it may seem like the functionality of a class is perfectly obvious, any consumers of your API may not be able to pick up on certain details.
Bad Practice
Consider a case where the class given below can be instantiated and provides certain functionalities within each instance in a thread-safe manner, perhaps it is a rest API client.
If there is no documentation comment on the class, it is not immediately obvious that the class is thread safe. Thus, multiple instances of the class may be created to perform operations concurrently, using up both memory as well as OS resources like sockets. If it were known from the beginning that the class were thread safe, the user would not need to create unnecessary extra instances of SomeClass.
class SomeClass {
// ...
}
Recommended
Make sure to add useful information regarding the usage or implementation of a particular declaration, so that anything about it which can't be understood from the name or some other cue is correctly conveyed.
/**
* Instances of this class are used to perform xyz action.
*
* This class is thread safe and the same instance can be used over multiple threads.
*/
class SomeClass {
// ...
}
Exceptions
This issue will not be reported for model entity classes. If there is any non-obvious behavior associated with a particular class however, do consider documenting it.