... | ... | @@ -60,40 +60,43 @@ That's it! You have now installed and can use Bito AI in Visual Studio Code. Enj |
|
|
* Define the prompt for you documentation task.\
|
|
|
An example for media wiki documentation task:
|
|
|
|
|
|
---
|
|
|
|
|
|
```
|
|
|
Your task is to analyze the code given below for create documentation in english. Generate all lines of documentation without any whitespace at the beginning of the line. The documentation generatede was based on the mediawiki standard following the template below:
|
|
|
```
|
|
|
Your task is to analyze the code given below for create documentation in english.
|
|
|
Generate all lines of documentation without any whitespace at the beginning of the line.
|
|
|
The documentation generatede was based on the mediawiki standard following the template below:
|
|
|
|
|
|
```
|
|
|
{{Codesample | code = {{%code%}}
|
|
|
```
|
|
|
-----
|
|
|
=== '''<Here show the function name>''' ===
|
|
|
|
|
|
```
|
|
|
| lang = javascript | name = | line = 1 | start = 1 | scheme = light }}
|
|
|
```
|
|
|
''<Explain code in paragraph>''
|
|
|
|
|
|
```
|
|
|
===='''Inputs:'''====''<Bulleted List and explain each function inputs. If no inputs is found, output "No input parameters for this function.">''
|
|
|
```
|
|
|
{{Codesample
|
|
|
| code = {{%code%}}
|
|
|
|
|
|
```
|
|
|
===='''Output:'''====''<Bulleted List and explain each function outputs.''
|
|
|
```
|
|
|
| lang = javascript
|
|
|
| name = <Here show the function name>
|
|
|
| line = 1
|
|
|
| start = 1
|
|
|
| scheme = light
|
|
|
}}
|
|
|
|
|
|
```
|
|
|
===='''Use'''====
|
|
|
```
|
|
|
===='''Inputs:'''====
|
|
|
''<Bulleted List and explain each function inputs. If no inputs is found, output "No input parameters for this function.">''
|
|
|
|
|
|
```
|
|
|
''<Here describe in bullet steps and in datails, the function utilization>''
|
|
|
```
|
|
|
===='''Output:'''====
|
|
|
''<Bulleted List and explain each function outputs.''
|
|
|
|
|
|
```
|
|
|
{{Codesample | code = ; | lang = javascript | name = Use example: | line = 1 | start = 1 | scheme = light }}
|
|
|
```
|
|
|
===='''Use'''====
|
|
|
|
|
|
---
|
|
|
''<Here describe in bullet steps and in datails, the function utilization>''
|
|
|
|
|
|
1. |
|
|
\ No newline at end of file |
|
|
{{Codesample
|
|
|
| code = <Given a code example for the call function>;
|
|
|
| lang = javascript
|
|
|
| name = Use example:
|
|
|
| line = 1
|
|
|
| start = 1
|
|
|
| scheme = light
|
|
|
}}
|
|
|
<hr>
|
|
|
``` |
|
|
\ No newline at end of file |