Code Formatting

Question 1

What is the recommended order of elements within a Java source file?

Answer 1

Beginning comments, Import statements, Class declarations, Class documentation comments, Class (static) variables (First public, then protected, then private), Constructors, and Methods.

Question 2

What are beginning comments in a Java source file?

Answer 2

Beginning comments are a section of comments that provide an overview of the Java source file, including the purpose of the file and any other relevant information.

Question 3

What is the purpose of import statements in a Java source file?

Answer 3

Import statements allow Java programs to access classes and methods from other Java packages or libraries.

Question 4

How should class variables be ordered in a Java source file?

Answer 4

Class variables should be ordered by visibility, with public variables first, followed by protected, and then private.

Question 5

What is the purpose of constructors in a Java class?

Answer 5

Constructors are special methods used to initialize objects of a class when they are created.

Question 6

How should methods be ordered in a Java source file?

Answer 6

Methods should be ordered by functionality, with related methods grouped together.

Question 7

What is the importance of following a recommended order in a Java source file?

Answer 7

Following a recommended order in a Java source file helps to improve the readability and maintainability of the code, making it easier for other developers to understand and modify the code in the future.

Question 8

What is the recommended unit of indentation in Java source files?

Answer 8

The recommended unit of indentation in Java source files is four spaces.

Question 9

Are tabs or white-space allowed for indentation in Java source files?

Answer 9

Yes, both tabs and white-space are allowed for indentation in Java source files.

Question 10

What is MR’s comment on using tabs for indentation?

Answer 10

MR’s comment is that tabs are devilish.

Question 11

What is the recommended maximum line length in Java source files?

Answer 11

The recommended maximum line length in Java source files is 80 characters.

Question 12

Why is it recommended avoiding lines longer than 80 characters in Java source files?

Answer 12

It is recommended to avoid lines longer than 80 characters in Java source files to improve code readability and maintainability. Long lines can be difficult to read and understand, especially when working with code on smaller screens or devices.

Question 13

Why is one declaration per line is preferred over multi-line declaration

Answer 13

Having one declaration per line makes the code more readable and easier to maintain. It also helps to avoid errors when modifying the code, since each declaration is clearly separated from the others. Additionally, it allows for easier tracking of changes in version control systems, as each declaration will have its own line in the commit history

Question 14

What is the recommended practice for declaring variables in code?

Answer 14

The recommended practice is to put one declaration per line and to place declarations only at the beginning of blocks.

Question 15

What is the reason for placing declarations only at the beginning of blocks?

Answer 15

Placing declarations only at the beginning of blocks helps improve code readability and maintainability by making it easier for developers to understand the scope of variables.

Question 16

What is a block in code?

Answer 16

A block is any code surrounded by curly braces, “{“, and “}”. This can include loops, conditional statements, functions, and more.

Question 17

Why is it important to follow best practices for declarations?

Answer 17

Following best practices for declarations can help improve code quality, readability, and maintainability. It can also help prevent bugs and make it easier for other developers to work with the code.

Question 18

What is the recommended placement of the open brace in a Java class declaration?

Answer 18

The open brace “{“ in a Java class declaration should appear at the end of the same line as the declaration statement.

Question 19

Where should the closing brace appear in a Java class declaration?

Answer 19

The closing brace “}” in a Java class declaration should start a line by itself and be indented to match its corresponding opening statement.

Question 20

Should there be any space between a method name and the parenthesis starting its parameter list in a Java class declaration?

Answer 20

No, there should not be any space between a method name and the parenthesis “(“ starting its parameter list in a Java class declaration.

Question 21

How should methods be separated in a Java class declaration?

Answer 21

Methods in a Java class declaration should be separated by a blank line.

Question 22

What is the recommended spacing for a keyword followed by a parenthesis?

Answer 22

A space should be used to separate a keyword and its following parenthesis.

Question 23

Should there be a space between a method name and its opening parenthesis?

Answer 23

No, there should be no blank space between a method name and its opening parenthesis.

Question 24

Should there be a blank space after commas in argument lists?

Answer 24

Yes, a blank space should be used after commas in argument lists.

Question 25

Should binary operators be separated from their operands by spaces?

Answer 25

Yes, all binary operators except for the dot operator should be separated from their operands by spaces.

Question 26

Should unary operators be separated from their operands by spaces?

Answer 26

No, unary operators such as unary minus, increment, and decrement should not be separated from their operands by blank spaces.

Question 27

What is Checkstyle?

Answer 27

Checkstyle is a development tool used to check whether Java code adheres to a specified coding standard.

Question 28

Why is Checkstyle useful?

Answer 28

Checkstyle is useful because it automates the process of checking Java code for adherence to a coding standard. This can help to ensure consistency in coding practices and reduce the potential for errors.

Question 29

What does Checkstyle check for?

Answer 29

Checkstyle checks for a wide range of coding practices, including indentation, line length, variable names, and spacing.

Question 30

Can Checkstyle be customized to adhere to specific coding standards?

Answer 30

Yes, Checkstyle can be customized to adhere to specific coding standards. It provides a range of pre-defined checks, and developers can also write their own custom checks.

Question 31

Is Checkstyle limited to Java code?

Answer 31

Yes, Checkstyle is designed specifically for Java code.

Question 32

Can Checkstyle be integrated with other development tools?

Answer 32

Yes, Checkstyle can be integrated with a range of other development tools, including build systems and integrated development environments (IDEs).

Question 33

Does Checkstyle fix code issues automatically?

Answer 33

No, Checkstyle does not fix code issues automatically. Instead, it provides developers with feedback on code quality and adherence to coding standards. It is up to the developers to make any necessary changes.