| 1. |
In Api Document Explain How To Document Each Function ?what Are The Tools Used For Documentation? |
|
Answer» Description: Small description about what a function does Syntax: Syntax about the parameter of the code, the sequence in which they OCCUR, required and optional elements ETC. Parameters: Functions parameters Error MESSAGES: Syntax of error messages EXAMPLE Code: Small snippet of code Related Links: Related functions POPULAR tools used for API documentations are JavaDoc (for Java code ) Doxygen (for .Net code) Description: Small description about what a function does Syntax: Syntax about the parameter of the code, the sequence in which they occur, required and optional elements etc. Parameters: Functions parameters Error Messages: Syntax of error messages Example Code: Small snippet of code Related Links: Related functions Popular tools used for API documentations are JavaDoc (for Java code ) Doxygen (for .Net code) |
|