Sid672 / Java

Learn about java.
Apache License 2.0
0 stars 9 forks source link

Required Documentation comment in the starting of programs. #6

Closed Sid672 closed 3 years ago

Sid672 commented 3 years ago

Comments need to be added in the header of the program which gives information about the program. Programs are present in the "Programs" folder. If the program already contains comments then only change the format of comments.

Example:

public class Main {
  public static void main(String[] agrs) {

      Integer i = Integer.valueOf("123");
      int a = i + 2;
      System.out.println(a);
      System.out.println(i);
  }
}
/**
  * Program converts the string into an integer.
  * add 2 and print the result.
  */ 

public class Main {
  public static void main(String[] agrs) {

      Integer i = Integer.valueOf("123");
      int a = i + 2;
      System.out.println(a);
      System.out.println(i);
  }
}

Comments format:

/**
  * comments here;
  */
diksharai9 commented 3 years ago

hey! May I help you with this?

Sid672 commented 3 years ago

@diksharai9, Go ahead! You can start from program 11 in the Programs folder.

diksharai9 commented 3 years ago

@diksharai9, Go ahead! You can start from program 11 in the Programs folder.

thankyou

Sid672 commented 3 years ago

Now, Modification is required from Program 31 onwards.

Sid672 commented 3 years ago

Up to program 50 documentation comments is completed.

Sid672 commented 3 years ago

Modfication are required from Program52.java

ritesh-karankal commented 3 years ago

Hey! can I modify the rest of the comments?

Sid672 commented 3 years ago

@ritesh-karankal go ahead. Start from program 52 that is present in the directory of the programs.

ritesh-karankal commented 3 years ago

@Sid672 I have two questions do I need to change single-line comments to multi-line comments? And does the spacing of asterisks matter as other files have different spacing than above mentioned correct format?

Sid672 commented 3 years ago

@ritesh-karankal Yes please convert single-line comments into multiple-line comments. If you follow the above format it's the most correct way. I know some files have comments that don't follow the same format for such files I will create a new issue after closing this issue.

Sid672 commented 3 years ago

Work is completed by @diksharai9, @ANUJTIWARI007, @ritesh-karankal. Thanks!