diff options
| author | Bram Moolenaar <Bram@vim.org> | 2019-11-26 21:44:46 +0100 |
|---|---|---|
| committer | Bram Moolenaar <Bram@vim.org> | 2019-11-26 21:44:46 +0100 |
| commit | 0c0734d527a132edfb4089be48486586424b3f41 (patch) | |
| tree | 6dc04964a23e8c85be6283a1642c06f2003bc7c2 /runtime/doc/develop.txt | |
| parent | fc4ea2a72d36de1196a3ce17352e72f8fe90f4bb (diff) | |
Update runtime files
Diffstat (limited to 'runtime/doc/develop.txt')
| -rw-r--r-- | runtime/doc/develop.txt | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/runtime/doc/develop.txt b/runtime/doc/develop.txt index 59e44dcaab..6ced5156cb 100644 --- a/runtime/doc/develop.txt +++ b/runtime/doc/develop.txt @@ -1,4 +1,4 @@ -*develop.txt* For Vim version 8.1. Last change: 2019 Aug 05 +*develop.txt* For Vim version 8.1. Last change: 2019 Nov 22 VIM REFERENCE MANUAL by Bram Moolenaar @@ -195,10 +195,14 @@ problems for existing patches. Only use them for new and changed code. Comments ~ -Traditionally Vim uses /* comments */. We intend to keep it that way, -especially for file and function headers. For new code or lines of code that -change, it is allowed to use // comments. Especially when it comes after -code: +Traditionally Vim uses /* comments */. We intend to keep it that way +for file and function headers and larger blocks of code, E.g.: + /* + * The "foo" argument does something useful. + * Return OK or FAIL. + */ +For new code or lines of code that change, it is preferred to use // comments. +Especially when it comes after code: int some_var; // single line comment useful here Enums ~ |