microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2025-12-11 02:08:52 -06:00
Code Issues Packages Projects Releases 177 Wiki Activity

Merge remote-tracking branch 'upstream/master' into HEAD

VSO-Build-Agent 2016-11-24 16:57:10 +00:00
commit bd88b6ceb6
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Extension-API-guidelines.md

@ -87,6 +87,10 @@ Copy Data
Don’t send the data that a provider returned over the wire. Often it containa more information than we need and often there are cyclic dependencies. Use the provider data to create objects that your protocol speaks.
Strict Null
-
We define the API with strictNull-checks in mind. That means we use the optional annotation `foo?: number` and `null` or `undefined` in type annotations. For instance, its `activeTextEditor: TextEditor | undefined`. Again, be strict for types we define and relaxed when accepting data.
JSDOC
-
We add JSDoc for all parts of the API. The doc is supported by markdown syntax. When document string-datatypes that end up in the UI, use the phrase ‘Human-readable string…’
We add JSDoc for all parts of the API. The doc is supported by markdown syntax. When document string-datatypes that end up in the UI, use the phrase ‘Human-readable string…’