Skip to content

Commit 74ee7d0

Browse files
authored
Add code fencing (dotnet#7155)
1 parent acb2148 commit 74ee7d0

File tree

1 file changed

+32
-30
lines changed

1 file changed

+32
-30
lines changed

xml/Microsoft.CSharp/Compiler.xml

Lines changed: 32 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@
2525
<remarks>
2626
<format type="text/markdown"><![CDATA[
2727
28-
## Remarks
29-
To compile C\# code in-process, call <xref:Microsoft.CSharp.Compiler.Compile(System.String[],System.String[],System.String,System.String[],System.Collections.IDictionary)>.
28+
## Remarks
29+
30+
To compile C# code in-process, call <xref:Microsoft.CSharp.Compiler.Compile(System.String[],System.String[],System.String,System.String[],System.Collections.IDictionary)>.
3031
3132
]]></format>
3233
</remarks>
@@ -66,40 +67,41 @@ To compile C\# code in-process, call <xref:Microsoft.CSharp.Compiler.Compile(Sys
6667
<remarks>
6768
<format type="text/markdown"><![CDATA[
6869
69-
## Remarks
70-
Each string in the sourceTexts parameter is the equivalent of a single source file. There must be at least one sourceTexts element.
70+
## Remarks
71+
72+
Each string in the `sourceTexts` parameter is the equivalent of a single source file. There must be at least one `sourceTexts` element.
7173
72-
The file names in the sourceTextNames parameter are used for compiler diagnostics and debug information. The array is required, but it can be locally overridden by use of the \#line directive. The array must have the same number of elements as the sourceTexts parameter.
74+
The file names in the `sourceTextNames` parameter are used for compiler diagnostics and debug information. The array is required, but it can be locally overridden by use of the `#line` directive. The array must have the same number of elements as the `sourceTexts` parameter.
7375
74-
The imports parameter is the same as the /reference compiler option. This parameter `null`.
76+
The `imports` parameter is the same as the `/reference` compiler option. This parameter can be `null`.
7577
76-
For the options parameter, the key is the short form of the compiler option. The value is the value desired for the option. The options parameter can be `null`. Some compiler options are not recognized. Recognized options and value:
78+
For the `options` parameter, the key is the short form of the compiler option. The value is the value desired for the option. The `options` parameter can be `null`. Some compiler options are not recognized. The following table shows the recognized options and values.
7779
7880
| Key Name | Usage |
7981
| --- | --- |
80-
| addmodule | List of modules to include in this assembly. The module names must be separated by the vertical bar or pipe character. Value must be of type <xref:System.String>. See [-addmodule (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/addmodule-compiler-option). |
81-
| baseaddress | Base address for libraries. Value must be of type <xref:System.UInt32>. See [-baseaddress (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/baseaddress-compiler-option). |
82-
| bugreport | Produces bug report file. Value must be of type <xref:System.String>. See [-bugreport (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/bugreport-compiler-option). |
83-
| checked | Set default expression evaluation to checked (or unchecked). Value must be of type <xref:System.Boolean>. See [-checked (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/checked-compiler-option). |
84-
| d | List of semicolon separated symbols to define. Value must be of type <xref:System.String>. See [-define (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/define-compiler-option). |
85-
| debug | Emit debug information with output. Value must be of type <xref:System.Boolean>. Full or pdb-only cannot be specified. See [-debug (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/debug-compiler-option). |
86-
| doc | File name to put XML comments in. Value must be of type <xref:System.String>. See [-doc (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/doc-compiler-option). |
87-
| filealign | PE section alignment size. Value must be of type <xref:System.UInt32>. See [-filealign (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/filealign-compiler-option). |
88-
| incr | Enable incremental rebuild. Value must be of type <xref:System.Boolean>. |
89-
| lib | Additional paths to search when locating modules and referenced assemblies. Value must be of type <xref:System.String>. See [-lib (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/lib-compiler-option). |
90-
| linkres | Link a managed resource to the assembly. Value must be of type <xref:System.String>. See [-linkresource (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/linkresource-compiler-option). |
91-
| m | Type to search in for the Main method. Value must be of type <xref:System.String>. See [-main (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/main-compiler-option). |
92-
| nostdlib | Do not auto-reference mscorlib.dll. Value must be of type <xref:System.Boolean>. See [-nostdlib (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/nostdlib-compiler-option). |
93-
| nowarn | List of semicolon separated warning numbers to not report. Value must be of type <xref:System.String>. See [-nowarn (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/nowarn-compiler-option). |
94-
| o | Enable compiler optimizations. Value must be of type <xref:System.Boolean>. See [-optimize (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/optimize-compiler-option). |
95-
| r | Referenced assemblies. Value must be of type String. If more than one assembly is specified, the file name must be separated by the vertical bar or pipe character. See [-reference (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/reference-compiler-option). |
96-
| res | Embed a managed resource. Value must be of type <xref:System.String>. See [-resource (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/resource-compiler-option). |
97-
| target | Output file target type, one of the following: "library", "exe", "winexe", or "module". Value must be of type <xref:System.String>. See [-target (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/target-compiler-option). |
98-
| unsafe | Allow unsafe constructs. Value must be of type <xref:System.Boolean>. See [-unsafe (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/unsafe-compiler-option). |
99-
| w | Warning level (0-4). Value must be of type <xref:System.String>. See [-warn (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/warn-compiler-option). |
100-
| warnaserror | Report warning diagnostics as errors. Value must be of type <xref:System.Boolean>. See [-warnaserror (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/warnaserror-compiler-option). |
101-
| win32icon | Win32 icon for auto generated Win32 resource. Value must be of type <xref:System.String>. See [-win32icon (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/win32icon-compiler-option). |
102-
| win32res | Win32 resource file. Value must be of type <xref:System.String>. See [-win32res (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/win32res-compiler-option). |
82+
| `addmodule` | List of modules to include in this assembly. The module names must be separated by the vertical bar or pipe character. Value must be of type <xref:System.String>. See [-addmodule (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/addmodule-compiler-option). |
83+
| `baseaddress` | Base address for libraries. Value must be of type <xref:System.UInt32>. See [-baseaddress (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/baseaddress-compiler-option). |
84+
| `bugreport` | Produces bug report file. Value must be of type <xref:System.String>. See [-bugreport (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/bugreport-compiler-option). |
85+
| `checked` | Set default expression evaluation to checked (or unchecked). Value must be of type <xref:System.Boolean>. See [-checked (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/checked-compiler-option). |
86+
| `d` | List of semicolon separated symbols to define. Value must be of type <xref:System.String>. See [-define (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/define-compiler-option). |
87+
| `debug` | Emit debug information with output. Value must be of type <xref:System.Boolean>. Full or pdb-only cannot be specified. See [-debug (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/debug-compiler-option). |
88+
| `doc` | File name to put XML comments in. Value must be of type <xref:System.String>. See [-doc (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/doc-compiler-option). |
89+
| `filealign` | PE section alignment size. Value must be of type <xref:System.UInt32>. See [-filealign (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/filealign-compiler-option). |
90+
| `incr` | Enable incremental rebuild. Value must be of type <xref:System.Boolean>. |
91+
| `lib` | Additional paths to search when locating modules and referenced assemblies. Value must be of type <xref:System.String>. See [-lib (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/lib-compiler-option). |
92+
| `linkres` | Link a managed resource to the assembly. Value must be of type <xref:System.String>. See [-linkresource (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/linkresource-compiler-option). |
93+
| `m` | Type to search in for the Main method. Value must be of type <xref:System.String>. See [-main (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/main-compiler-option). |
94+
| `nostdlib` | Do not auto-reference mscorlib.dll. Value must be of type <xref:System.Boolean>. See [-nostdlib (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/nostdlib-compiler-option). |
95+
| `nowarn` | List of semicolon separated warning numbers to not report. Value must be of type <xref:System.String>. See [-nowarn (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/nowarn-compiler-option). |
96+
| `o` | Enable compiler optimizations. Value must be of type <xref:System.Boolean>. See [-optimize (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/optimize-compiler-option). |
97+
| `r` | Referenced assemblies. Value must be of type String. If more than one assembly is specified, the file name must be separated by the vertical bar or pipe character. See [-reference (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/reference-compiler-option). |
98+
| `res` | Embed a managed resource. Value must be of type <xref:System.String>. See [-resource (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/resource-compiler-option). |
99+
| `target` | Output file target type, one of the following: "library", "exe", "winexe", or "module". Value must be of type <xref:System.String>. See [-target (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/target-compiler-option). |
100+
| `unsafe` | Allow unsafe constructs. Value must be of type <xref:System.Boolean>. See [-unsafe (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/unsafe-compiler-option). |
101+
| `w` | Warning level (0-4). Value must be of type <xref:System.String>. See [-warn (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/warn-compiler-option). |
102+
| `warnaserror` | Report warning diagnostics as errors. Value must be of type <xref:System.Boolean>. See [-warnaserror (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/warnaserror-compiler-option). |
103+
| `win32icon` | Win32 icon for auto generated Win32 resource. Value must be of type <xref:System.String>. See [-win32icon (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/win32icon-compiler-option). |
104+
| `win32res` | Win32 resource file. Value must be of type <xref:System.String>. See [-win32res (C# Compiler Options)](/dotnet/csharp/language-reference/compiler-options/win32res-compiler-option). |
103105
104106
]]></format>
105107
</remarks>

0 commit comments

Comments
 (0)