-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9e3cfe5
commit 86ac76d
Showing
4 changed files
with
58 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
/** | ||
* Description paragraph here. | ||
* | ||
* @param first The 1st param description. | ||
* @param second The 2nd param description. | ||
* @param third The 3rd param, by default 'value'. (optional) | ||
* @return Description of the return value. | ||
* @throws KeyError When a key error occurs. | ||
* @throws OtherError When another error occurs. | ||
* | ||
* Examples: | ||
* - Some minimal examples of using the function should go here. | ||
* - For example: | ||
* <pre> | ||
* int[] result1 = myFunction(arg1, arg2); | ||
* System.out.println(result1); // Output: some result | ||
* </pre> | ||
* | ||
* <pre> | ||
* List<Integer> seqList = sequentialList(1, 5); | ||
* System.out.println(seqList); // Output: [1, 2, 3, 4] | ||
* System.out.println(seqList.size()); // Output: 4 | ||
* System.out.println(Collections.min(seqList)); // Output: 1 | ||
* </pre> | ||
*/ | ||
public ReturnType myFunction(ParameterType1 first, ParameterType2 second, ParameterType3 third) { | ||
// Function implementation here. | ||
} |
21 changes: 21 additions & 0 deletions
21
resources/templates/function_templates/javascript_typescript_template.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
/** | ||
* Description paragraph here. | ||
* | ||
* @param {array_like} first - The 1st param description. | ||
* @param {type} second - The 2nd param description. | ||
* @param {object} [third='value'] - The 3rd param, by default 'value'. (optional) | ||
* | ||
* @returns {type} - Description of the return value. | ||
* | ||
* @throws {ErrorType1} - Description of the first error condition. | ||
* @throws {ErrorType2} - Description of the second error condition. | ||
* | ||
* @example | ||
* // Example 1: Describe how to use the function with sample inputs and outputs. | ||
* const result1 = myFunction(arg1, arg2); | ||
* console.log(result1); // Output: some result | ||
* | ||
* // Example 2: Provide another example. | ||
* const result2 = myFunction(arg3, arg4); | ||
* console.log(result2); // Output: some other result | ||
*/ |
1 change: 1 addition & 0 deletions
1
resources/fn_docstring_template.txt → ...es/function_templates/python_template.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
""" | ||
|
||
Description paragraph here. | ||
|
||
Parameters | ||
|