Merge pull request #991 from mispencer/ReadmeUpdateForCSharpImprovements
Updates to the README for recent C# support changes
This commit is contained in:
commit
94a0a61e67
52
README.md
52
README.md
@ -471,9 +471,10 @@ Completer API.
|
|||||||
|
|
||||||
### Diagnostic display
|
### Diagnostic display
|
||||||
|
|
||||||
YCM will display diagnostic notifications if you compiled YCM with Clang
|
YCM will display diagnostic notifications for C-family and C# languages if you
|
||||||
support. Since YCM continuously recompiles your file as you type, you'll get
|
compiled YCM with Clang and Omnisharp support, respectively. Since YCM continuously
|
||||||
notified of errors and warnings in your file as fast as possible.
|
recompiles your file as you type, you'll get notified of errors and warnings
|
||||||
|
in your file as fast as possible.
|
||||||
|
|
||||||
Here are the various pieces of the diagnostic UI:
|
Here are the various pieces of the diagnostic UI:
|
||||||
|
|
||||||
@ -515,6 +516,15 @@ another (very small) Vim plugin called [ListToggle][] (which also makes it
|
|||||||
possible to change the height of the `locationlist` window), also written by
|
possible to change the height of the `locationlist` window), also written by
|
||||||
yours truly.
|
yours truly.
|
||||||
|
|
||||||
|
#### C# Diagnostic Support
|
||||||
|
Unlike the C-family diagnostic support, the C# diagnostic support is not a full
|
||||||
|
compile run. Instead, it is a simple syntax check of the current file _only_.
|
||||||
|
The `:YcmForceCompileAndDiagnostics` command also is only a simple syntax check,
|
||||||
|
_not_ a compile. This means that only syntax errors will be displayed, and not
|
||||||
|
semantic errors. For example, omitting the semicolon at the end of statement
|
||||||
|
will be displayed as a diagnostic error, but using a nonexistence class or
|
||||||
|
variable will not be.
|
||||||
|
|
||||||
#### Diagnostic highlighting groups
|
#### Diagnostic highlighting groups
|
||||||
|
|
||||||
You can change the styling for the highlighting groups YCM uses. For the signs
|
You can change the styling for the highlighting groups YCM uses. For the signs
|
||||||
@ -637,7 +647,8 @@ Supported in filetypes: `c, cpp, objc, objcpp, python, cs`
|
|||||||
This command tries to perform the "most sensible" GoTo operation it can.
|
This command tries to perform the "most sensible" GoTo operation it can.
|
||||||
Currently, this means that it tries to look up the symbol under the cursor and
|
Currently, this means that it tries to look up the symbol under the cursor and
|
||||||
jumps to its definition if possible; if the definition is not accessible from
|
jumps to its definition if possible; if the definition is not accessible from
|
||||||
the current translation unit, jumps to the symbol's declaration.
|
the current translation unit, jumps to the symbol's declaration. For C#,
|
||||||
|
implementations are also considered and preferred.
|
||||||
|
|
||||||
Supported in filetypes: `c, cpp, objc, objcpp, python, cs`
|
Supported in filetypes: `c, cpp, objc, objcpp, python, cs`
|
||||||
|
|
||||||
@ -687,6 +698,30 @@ work as separate servers that YCM talks to.
|
|||||||
|
|
||||||
Supported in filetypes: `cs`
|
Supported in filetypes: `cs`
|
||||||
|
|
||||||
|
### The `ReloadSolution` subcommand
|
||||||
|
|
||||||
|
Instruct the Omnisharp server to clear its cache and reload all files from disk.
|
||||||
|
This is useful when files are added, removed, or renamed in the solution, files
|
||||||
|
are changed outside of Vim, or whenever Omnisharp cache is out-of-sync.
|
||||||
|
|
||||||
|
Supported in filetypes: `cs`
|
||||||
|
|
||||||
|
### The `GoToImplemention` subcommand
|
||||||
|
|
||||||
|
Looks up the symbol under the cursor and jumps to its implementation (i.e.
|
||||||
|
non-interface). If there are multiple implementations, instead provides a list
|
||||||
|
of implementations to choose from.
|
||||||
|
|
||||||
|
Supported in filetypes: `cs`
|
||||||
|
|
||||||
|
### The `GoToImplementationElseDeclaration` subcommand
|
||||||
|
|
||||||
|
Looks up the symbol under the cursor and jumps to its implementation if one,
|
||||||
|
else jump to its declaration. If there are multiple implementations, instead
|
||||||
|
provides a list of implementations to choose from.
|
||||||
|
|
||||||
|
Supported in filetypes: `cs`
|
||||||
|
|
||||||
Options
|
Options
|
||||||
-------
|
-------
|
||||||
|
|
||||||
@ -1107,15 +1142,6 @@ Default: `info`
|
|||||||
|
|
||||||
let g:ycm_server_log_level = 'info'
|
let g:ycm_server_log_level = 'info'
|
||||||
|
|
||||||
### The `g:ycm_csharp_server_port` option
|
|
||||||
|
|
||||||
The port number (on `localhost`) on which the OmniSharp server should be
|
|
||||||
started.
|
|
||||||
|
|
||||||
Default: `2000`
|
|
||||||
|
|
||||||
let g:ycm_csharp_server_port = 2000
|
|
||||||
|
|
||||||
### The `g:ycm_auto_start_csharp_server` option
|
### The `g:ycm_auto_start_csharp_server` option
|
||||||
|
|
||||||
When set to `1`, the OmniSharp server will be automatically started (once per
|
When set to `1`, the OmniSharp server will be automatically started (once per
|
||||||
|
Loading…
x
Reference in New Issue
Block a user