search

CertifaiAI / cdle-traininglabs

Certifai Training Labs Repository using Eclipse Deeplearning4j
https://certifai.ai/
Apache License 2.0
41 stars 70 forks source link

Inconsistent code commenting styles #172

Open TINGWEIJING opened 3 years ago

TINGWEIJING commented 3 years ago

Style Inconsistency

Just a suggestion for improvement in code commenting.

Evidence

  1. Inconsistent block comments

https://github.com/CertifaiAI/cdle-traininglabs/blob/725a6e4e5bf4f58d3bc73d68bd1cd1a09ba9b817/dl4j-labs/src/main/java/ai/certifai/training/classification/BirdClassification.java#L54-L61

https://github.com/CertifaiAI/cdle-traininglabs/blob/725a6e4e5bf4f58d3bc73d68bd1cd1a09ba9b817/dl4j-labs/src/main/java/ai/certifai/training/classification/HeartDiseaseBinaryClassification.java#L57-L76

https://github.com/CertifaiAI/cdle-traininglabs/blob/725a6e4e5bf4f58d3bc73d68bd1cd1a09ba9b817/dl4j-labs/src/main/java/ai/certifai/training/datavec/kfold/SimpleKFoldDemo.java#L37-L45

  1. Inconsistent end-of-line comments

https://github.com/CertifaiAI/cdle-traininglabs/blob/725a6e4e5bf4f58d3bc73d68bd1cd1a09ba9b817/dl4j-labs/src/main/java/ai/certifai/training/classification/Multiclass.java#L93-L98

https://github.com/CertifaiAI/cdle-traininglabs/blob/725a6e4e5bf4f58d3bc73d68bd1cd1a09ba9b817/dl4j-labs/src/main/java/ai/certifai/training/classification/OverfittingGermanCreditClassification.java#L121-L128

https://github.com/CertifaiAI/cdle-traininglabs/blob/725a6e4e5bf4f58d3bc73d68bd1cd1a09ba9b817/dl4j-labs/src/main/java/ai/certifai/training/earlyStopping/EarlyStopping.java#L99-L103

  1. Inconsistent method documentation comment

https://github.com/CertifaiAI/cdle-traininglabs/blob/725a6e4e5bf4f58d3bc73d68bd1cd1a09ba9b817/dl4j-labs/src/main/java/ai/certifai/training/classification/OverfittingGermanCreditClassification.java#L199-L208

https://github.com/CertifaiAI/cdle-traininglabs/blob/725a6e4e5bf4f58d3bc73d68bd1cd1a09ba9b817/dl4j-labs/src/main/java/ai/certifai/training/generative/MnistGAN.java#L151-L155

Possible solution

Just follow one of the styles and make it all consistent.
Styling references:

github-actions[bot] commented 3 years ago

👋 @TINGWEIJING Thank you for raising an issue. We will investigate into the matter and get back to you as soon as possible. Please make sure you have given us as much context as possible.