-
Notifications
You must be signed in to change notification settings - Fork 29
/
Copy pathpldoc.json
47 lines (46 loc) · 1.73 KB
/
pldoc.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
{
/*
This is the default definition for your function or procedure.
You can create your own file and specify his location with the setting "plsql-language.pldoc.path"
(don't modify this file, it'll be overwritten with the update of the extension !)
The definition is like snippets with some specific variables:
${PLDOC_TYPE}: function or procedure
${PLDOC_OBJECT}: name of function or procedure
${PLDOC_PARAM}: name of parameter
${PLDOC_PARAM_TYPE}: type of parameter
${PLDOC_AUTHOR}: author (see setting)
${PLDOC_DATE}: current date
${PLDOC_DATE|dd/mm/yyyy}: current date with format according to https://www.npmjs.com/package/dateformat
*/
"pldoc": {
"prefix": "__doc", // '__' for first position in snippet list
"body": [
"/**",
" * Description: ${0:Description}",
" *",
" * Author: ${PLDOC_AUTHOR}",
" * Created: ${PLDOC_DATE}",
" *",
" * Param: ${PLDOC_PARAM} ${1:Description}",
" * Return: ${2:Description}",
" */"
],
"description": "Documentation for your function or procedure"
}
/*
You can also define custom snippet (warning only in pldoc.json, not in regular snippet plsql.json)
The available variables are
${PLDOC_AUTHOR}: author (see setting)
${PLDOC_DATE}: current date
${PLDOC_DATE|dd/mm/yyyy}: current date with format according to https://www.npmjs.com/package/dateformat
*/
/*
"pllastUpdate": {
"prefix": "__last",
"body": [
"${PLDOC_AUTHOR} ${PLDOC_DATE}"
],
"description": "Author and date"
}
*/
}