docs(devkit-core): Optimised javadoc.
This commit is contained in:
+3
-11
@@ -18,31 +18,23 @@
|
|||||||
package cn.org.codecrafters.devkit.core.exceptions;
|
package cn.org.codecrafters.devkit.core.exceptions;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* NotImplementedException - Custom Runtime Exception
|
|
||||||
* <p>
|
|
||||||
* The {@code NotImplementedException} class is a custom runtime exception
|
* The {@code NotImplementedException} class is a custom runtime exception
|
||||||
* that represents a situation where a particular method or functionality is
|
* that represents a situation where a particular method or functionality is
|
||||||
* not implemented or is currently unavailable in the codebase. It extends the
|
* not implemented or is currently unavailable in the codebase.
|
||||||
* standard {@code RuntimeException} class, making it an unchecked exception.
|
|
||||||
*
|
|
||||||
* <p>
|
* <p>
|
||||||
* This exception is typically thrown when developers need to indicate that a
|
* This exception is typically thrown when developers need to indicate that a
|
||||||
* specific part of the code is incomplete or requires further implementation.
|
* specific part of the code is incomplete or requires further implementation.
|
||||||
* It serves as a placeholder to highlight unfinished sections of the
|
* It serves as a placeholder to highlight unfinished sections of the
|
||||||
* application during development and testing phases.
|
* application during development and testing phases.
|
||||||
*
|
|
||||||
* <p>
|
* <p>
|
||||||
* Usage Example:
|
* Usage Example:
|
||||||
*
|
|
||||||
* <pre>
|
* <pre>
|
||||||
* public void someMethod() {
|
* public void someMethod() {
|
||||||
* // Some code...
|
* // Some code...
|
||||||
* throw new NotImplementedException("""
|
* throw new NotImplementedException("""
|
||||||
* This feature will be implemented in a future release.
|
* This feature will be implemented in a future release.""");
|
||||||
* """);
|
|
||||||
* }
|
* }
|
||||||
* </pre>
|
* </pre>
|
||||||
*
|
|
||||||
* <b>Contact</b>
|
* <b>Contact</b>
|
||||||
* <ul>
|
* <ul>
|
||||||
* <li>
|
* <li>
|
||||||
@@ -55,7 +47,7 @@ package cn.org.codecrafters.devkit.core.exceptions;
|
|||||||
* </ul>
|
* </ul>
|
||||||
*
|
*
|
||||||
* @author Zihlu Wang
|
* @author Zihlu Wang
|
||||||
* @version 1.0.0
|
* @version 1.1.0
|
||||||
* @see RuntimeException
|
* @see RuntimeException
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*/
|
*/
|
||||||
|
|||||||
Reference in New Issue
Block a user