Skip to content

Commit 37bf70e

Browse files
CopilotBillWagner
andcommitted
Fix incorrect C# compiler option names in documentation
Co-authored-by: BillWagner <[email protected]>
1 parent 554c553 commit 37bf70e

File tree

11 files changed

+28
-33
lines changed

11 files changed

+28
-33
lines changed

docs/csharp/language-reference/compiler-options/advanced.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ helpviewer_keywords:
99
- "ChecksumAlgorithm compiler option [C#]"
1010
- "CodePage compiler option [C#]"
1111
- "Utf8Output compiler option [C#]"
12-
- "MainEntryPoint compiler option [C#]"
12+
- "StartupObject compiler option [C#]"
1313
- "GenerateFullPaths compiler option [C#]"
1414
- "FileAlignment compiler option [C#]"
1515
- "PathMap compiler option [C#]"
@@ -27,7 +27,7 @@ helpviewer_keywords:
2727

2828
The following options support advanced scenarios. The new MSBuild syntax is shown in **Bold**. The older `csc.exe` syntax is shown in `code style`.
2929

30-
- **MainEntryPoint**, **StartupObject** / `-main`: Specify the type that contains the entry point.
30+
- **StartupObject** / `-main`: Specify the type that contains the entry point.
3131
- **PdbFile** / `-pdb`: Specify debug information file name.
3232
- **PathMap** / `-pathmap`: Specify a mapping for source path names output by the compiler.
3333
- **ApplicationConfiguration** / `-appconfig`: Specify an application configuration file containing assembly binding settings.
@@ -54,21 +54,15 @@ You add any of these options in a `<PropertyGroup>` element in your `*.csproj` f
5454
</PropertyGroup>
5555
``````
5656

57-
## MainEntryPoint or StartupObject
57+
## StartupObject
5858

5959
This option specifies the class that contains the entry point to the program, if more than one class contains a `Main` method.
6060

6161
```xml
6262
<StartupObject>MyNamespace.Program</StartupObject>
6363
```
6464

65-
or
66-
67-
```xml
68-
<MainEntryPoint>MyNamespace.Program</MainEntryPoint>
69-
```
70-
71-
Where `Program` is the type that contains the `Main` method. The provided class name must be fully qualified; it must include the full namespace containing the class, followed by the class name. For example, when the `Main` method is located inside the `Program` class in the `MyApplication.Core` namespace, the compiler option has to be `-main:MyApplication.Core.Program`. If your compilation includes more than one type with a [`Main`](../../fundamentals/program-structure/main-command-line.md) method, you can specify which type contains the `Main` method.
65+
Where `Program` is the type that contains the `Main` method. The class name can be either fully qualified (including the namespace) or just the class name if it's unambiguous. For example, when the `Main` method is located inside the `Program` class in the `MyApplication.Core` namespace, you can specify either `-main:MyApplication.Core.Program` or just `-main:Program` if there's no ambiguity. If your compilation includes more than one type with a [`Main`](../../fundamentals/program-structure/main-command-line.md) method, you can specify which type contains the `Main` method.
7266

7367
> [!NOTE]
7468
> This option can't be used for a project that includes [top-level statements](../../fundamentals/program-structure/top-level-statements.md), even if that project contains one or more `Main` methods.
@@ -245,7 +239,7 @@ Use this option if you want to define or create your own System namespace and ob
245239
Specifies the minimum version of the subsystem on which the executable file runs. Most commonly, this option ensures that the executable file can use security features that aren’t available with older versions of Windows.
246240

247241
> [!NOTE]
248-
> To specify the subsystem itself, use the [**TargetType**](./output.md#targettype) compiler option.
242+
> To specify the subsystem itself, use the [**OutputType**](./output.md#outputtype) compiler option.
249243
250244
```xml
251245
<SubsystemVersion>major.minor</SubsystemVersion>
@@ -266,9 +260,9 @@ The following table lists common subsystem versions of Windows.
266260
The default value of the **SubsystemVersion** compiler option depends on the conditions in the following list:
267261

268262
- The default value is 6.02 if any compiler option in the following list is set:
269-
- [-target:appcontainerexe](output.md)
270-
- [-target:winmdobj](output.md)
271-
- [-platform:arm](output.md)
263+
- [-target:appcontainerexe](output.md#outputtype)
264+
- [-target:winmdobj](output.md#outputtype)
265+
- [-platform:arm](output.md#platformtarget)
272266
- The default value is 6.00 if you're using MSBuild, you're targeting .NET Framework 4.5, and you haven't set any of the compiler options that were specified earlier in this list.
273267
- The default value is 4.00 if none of the previous conditions are true.
274268

@@ -286,7 +280,7 @@ Specifies the name of an assembly whose nonpublic types a *.netmodule* can acces
286280
- You know the name of the assembly into which the .netmodule will be built.
287281
- The existing assembly has granted friend assembly access to the assembly into which the .*netmodule* will be built.
288282

289-
For more information on building a .netmodule, see [**TargetType**](output.md#targettype) option of **module**. For more information on friend assemblies, see [Friend Assemblies](../../../standard/assembly/friend.md).
283+
For more information on building a .netmodule, see [**OutputType**](output.md#outputtype) option of **module**. For more information on friend assemblies, see [Friend Assemblies](../../../standard/assembly/friend.md).
290284

291285
## ReportIVTs
292286

docs/csharp/language-reference/compiler-options/output.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ helpviewer_keywords:
99
- "OutputAssembly compiler option [C#]"
1010
- "PlatformTarget compiler option [C#]"
1111
- "ProduceReferenceAssembly compiler option [C#]"
12-
- "TargetType compiler option [C#]"
12+
- "OutputType compiler option [C#]"
1313
---
1414
# C# Compiler Options that control compiler output
1515

@@ -21,7 +21,7 @@ The following options control compiler output generation.
2121
| **OutputAssembly** | `-out:` | Specify the output assembly file. |
2222
| **PlatformTarget** | `-platform:` | Specify the target platform CPU. |
2323
| **ProduceReferenceAssembly** | `-refout:` | Generate a reference assembly. |
24-
| **TargetType** | `-target:` | Specify the type of the output assembly. |
24+
| **OutputType** | `-target:` | Specify the type of the output assembly. |
2525

2626
> [!NOTE]
2727
> Refer to [Compiler options](index.md#how-to-set-options) for more information on configuring these options for your project.
@@ -34,7 +34,7 @@ The **DocumentationFile** option allows you to place documentation comments in a
3434
<DocumentationFile>path/to/file.xml</DocumentationFile>
3535
```
3636

37-
The source code file that contains Main or top-level statements is output first into the XML. You'll often want to use the generated .xml file with [IntelliSense](/visualstudio/ide/using-intellisense). The *.xml* filename must be the same as the assembly name. The *.xml* file must be in the same directory as the assembly. When the assembly is referenced in a Visual Studio project, the *.xml* file is found as well. For more information about generating code comments, see [Supplying Code Comments](/visualstudio/ide/reference/generate-xml-documentation-comments). Unless you compile with [`<TargetType:Module>`](#targettype), `file` will contain `<assembly>` and `</assembly>` tags specifying the name of the file containing the assembly manifest for the output file. For examples, see [How to use the XML documentation features](../xmldoc/index.md).
37+
The source code file that contains Main or top-level statements is output first into the XML. You'll often want to use the generated .xml file with [IntelliSense](/visualstudio/ide/using-intellisense). The *.xml* filename must be the same as the assembly name. The *.xml* file must be in the same directory as the assembly. When the assembly is referenced in a Visual Studio project, the *.xml* file is found as well. For more information about generating code comments, see [Supplying Code Comments](/visualstudio/ide/reference/generate-xml-documentation-comments). Unless you compile with [`<OutputType:module>`](#outputtype), `file` will contain `<assembly>` and `</assembly>` tags specifying the name of the file containing the assembly manifest for the output file. For examples, see [How to use the XML documentation features](../xmldoc/index.md).
3838

3939
> [!NOTE]
4040
> The **DocumentationFile** option applies to all files in the project. To disable warnings related to documentation comments for a specific file or section of code, use [#pragma warning](../preprocessor-directives.md#pragma-warning).
@@ -43,13 +43,14 @@ This option can be used in any .NET SDK-style project. For more information, see
4343

4444
## OutputAssembly
4545

46-
The **OutputAssembly** option specifies the name of the output file. The output path specifies the folder where compiler output is placed.
46+
The **OutputAssembly** option specifies the name of the output file. This option corresponds to the combination of the `OutputPath` and `AssemblyName` MSBuild properties that control where the compiled assembly is placed and what it's named.
4747

4848
```xml
49-
<OutputAssembly>folder</OutputAssembly>
49+
<OutputPath>bin\Debug\</OutputPath>
50+
<AssemblyName>MyApplication</AssemblyName>
5051
```
5152

52-
Specify the full name and extension of the file you want to create. If you don't specify the name of the output file, MSBuild uses the name of the project to specify the name of the output assembly. Old style projects use the following rules:
53+
Specify the name and extension of the file you want to create. The path can be relative or absolute. If you don't specify the name of the output file, MSBuild uses the project name to specify the name of the output assembly. Old style projects use the following rules:
5354

5455
- An .exe will take its name from the source code file that contains the `Main` method or top-level statements.
5556
- A .dll or .netmodule will take its name from the first source code file.
@@ -103,9 +104,9 @@ You generally don't need to work directly with reference assembly files. By defa
103104

104105
.NET SDK 6.0.200 made a [change](../../../core/compatibility/sdk/6.0/write-reference-assemblies-to-obj.md) that moved reference assemblies from the output directory to the intermediate directory by default.
105106

106-
## TargetType
107+
## OutputType
107108

108-
The **TargetType** compiler option can be specified in one of the following forms:
109+
The **OutputType** compiler option can be specified in one of the following forms:
109110

110111
- **library**: to create a code library. **library** is the default value.
111112
- **exe**: to create an .exe file.
@@ -118,7 +119,7 @@ The **TargetType** compiler option can be specified in one of the following form
118119
> For .NET Framework targets, unless you specify **module**, this option causes a .NET Framework assembly manifest to be placed in an output file. For more information, see [Assemblies in .NET](../../../standard/assembly/index.md) and [Common Attributes](../attributes/global.md).
119120
120121
```xml
121-
<TargetType>library</TargetType>
122+
<OutputType>library</OutputType>
122123
```
123124

124125
The compiler creates only one assembly manifest per compilation. Information about all files in a compilation is placed in the assembly manifest. When producing multiple output files at the command line, only one assembly manifest can be created and it must go into the first output file specified on the command line.

docs/csharp/misc/cs0734.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The /moduleassemblyname option may only be specified when building a target type
1414

1515
The compiler option **ModuleAssemblyName** should only be used when building a .netmodule. See [**ModuleAssemblyName** (C# Compiler Option)](../language-reference/compiler-options/advanced.md#moduleassemblyname) for more information.
1616

17-
For more information on building a .netmodule, see the **module** element for the [**TargetType** (C# Compiler Options)](../language-reference/compiler-options/output.md#targettype).
17+
For more information on building a .netmodule, see the **module** element for the [**OutputType** (C# Compiler Options)](../language-reference/compiler-options/output.md#outputtype).
1818

1919
## Example
2020

docs/csharp/misc/cs1542.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ ms.assetid: d7f60aa2-6645-472c-ac12-fa57a09fbd87
1212

1313
'dll' cannot be added to this assembly because it already is an assembly; use '/R' option instead
1414

15-
The file that was referenced with the [**AddModules**](../language-reference/compiler-options/inputs.md#addmodules) compiler option was not built with **module** element of the [**TargetType** compiler option](../language-reference/compiler-options/output.md#targettype); use [**References**](../language-reference/compiler-options/inputs.md#references) to reference the file in this compilation.
15+
The file that was referenced with the [**AddModules**](../language-reference/compiler-options/inputs.md#addmodules) compiler option was not built with **module** element of the [**OutputType** compiler option](../language-reference/compiler-options/output.md#outputtype); use [**References**](../language-reference/compiler-options/inputs.md#references) to reference the file in this compilation.

docs/csharp/misc/cs1555.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ ms.assetid: 1919c8b8-d72c-44af-91d0-674ccde77c3f
1212

1313
Could not find 'class' specified for Main method
1414

15-
A class was specified to the [**MainEntryPoint**](../language-reference/compiler-options/advanced.md#mainentrypoint-or-startupobject) compiler option, but the class name was not found in the source code.
15+
A class was specified to the [**StartupObject**](../language-reference/compiler-options/advanced.md#startupobject) compiler option, but the class name was not found in the source code.
1616

1717
[!INCLUDE[csharp-build-only-diagnostic-note](~/includes/csharp-build-only-diagnostic-note.md)]

docs/csharp/misc/cs1556.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ ms.assetid: 960307d2-d815-4d7a-8f96-e3e78c038ade
1212

1313
'construct' specified for Main method must be a valid class or struct
1414

15-
The [**MainEntryPoint**](../language-reference/compiler-options/advanced.md#mainentrypoint-or-startupobject) compiler option was passed an identifier that was not a class name.
15+
The [**StartupObject**](../language-reference/compiler-options/advanced.md#startupobject) compiler option was passed an identifier that was not a class name.
1616

1717
[!INCLUDE[csharp-build-only-diagnostic-note](~/includes/csharp-build-only-diagnostic-note.md)]

docs/csharp/misc/cs1557.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ ms.assetid: 1615e028-aeb7-4788-bd87-8e49e502d698
1212

1313
Cannot use 'class' for Main method because it is in a different output file
1414

15-
The [**MainEntryPoint**](../language-reference/compiler-options/advanced.md#mainentrypoint-or-startupobject) compiler option was specified for one output file in a multi-output file compilation. However, the class was not found in the source code for the /main compilation; it was found in a source code file for one of the other output files in the compilation.
15+
The [**StartupObject**](../language-reference/compiler-options/advanced.md#startupobject) compiler option was specified for one output file in a multi-output file compilation. However, the class was not found in the source code for the /main compilation; it was found in a source code file for one of the other output files in the compilation.

docs/csharp/misc/cs1558.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.assetid: ee603d66-007e-4782-9285-7ff031975f0f
1212

1313
'class' does not have a suitable static Main method
1414

15-
The [**MainEntryPoint**](../language-reference/compiler-options/advanced.md#mainentrypoint-or-startupobject) compiler option specified a class in which to look for a **Main** method. However, the [Main](../fundamentals/program-structure/main-command-line.md) method was not defined correctly.
15+
The [**StartupObject**](../language-reference/compiler-options/advanced.md#startupobject) compiler option specified a class in which to look for a **Main** method. However, the [Main](../fundamentals/program-structure/main-command-line.md) method was not defined correctly.
1616

1717
[!INCLUDE[csharp-build-only-diagnostic-note](~/includes/csharp-build-only-diagnostic-note.md)]
1818

docs/csharp/misc/cs2019.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.assetid: eafd2531-8b3a-499c-9e12-a605a011396f
1212

1313
Invalid target type for /target: must specify 'exe', 'winexe', 'library', or 'module'
1414

15-
The [**TargetType**](../language-reference/compiler-options/output.md#targettype) compiler option was used, but an invalid parameter was passed. To resolve this error, recompile the program using the form of the **/target** option that is appropriate to your output file.
15+
The [**OutputType**](../language-reference/compiler-options/output.md#outputtype) compiler option was used, but an invalid parameter was passed. To resolve this error, recompile the program using the form of the **/target** option that is appropriate to your output file.
1616

1717
The following sample generates CS2017:
1818

docs/framework/tools/winmdexp-exe-windows-runtime-metadata-export-tool.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ winmdexp [options] winmdmodule
2727

2828
|Argument or option|Description|
2929
|------------------------|-----------------|
30-
|`winmdmodule`|Specifies the module (.winmdobj) to be exported. Only one module is allowed. To create this module, use the `/target` compiler option with the `winmdobj` target. See [-target:winmdobj (C# Compiler Options)](../../csharp/language-reference/compiler-options/output.md#targettype) or [-target (Visual Basic)](../../visual-basic/reference/command-line-compiler/target.md).|
30+
|`winmdmodule`|Specifies the module (.winmdobj) to be exported. Only one module is allowed. To create this module, use the `/target` compiler option with the `winmdobj` target. See [-target:winmdobj (C# Compiler Options)](../../csharp/language-reference/compiler-options/output.md#outputtype) or [-target (Visual Basic)](../../visual-basic/reference/command-line-compiler/target.md).|
3131
|`/docfile:` `docfile`<br /><br /> `/d:` `docfile`|Specifies the output XML documentation file that Winmdexp.exe will produce. In .NET Framework 4.5, the output file is essentially the same as the input XML documentation file.|
3232
|`/moduledoc:` `docfile`<br /><br /> `/md:` `docfile`|Specifies the name of the XML documentation file that the compiler produced with `winmdmodule`.|
3333
|`/modulepdb:` `symbolfile`<br /><br /> `/mp:` `symbolfile`|Specifies the name of the program database (PDB) file that contains symbols for `winmdmodule`.|

0 commit comments

Comments
 (0)