Add missing documentation for sln, buildprops, and buildtargets item templates #48191
+37
−2
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -3,7 +3,7 @@ title: .NET default templates for dotnet new | |||||
| description: The information about dotnet new templates shipped with dotnet SDK. | ||||||
| ms.custom: updateeachrelease | ||||||
| no-loc: [Blazor, WebAssembly] | ||||||
| ms.date: 08/29/2024 | ||||||
| --- | ||||||
| # .NET default templates for dotnet new | ||||||
|
There was a problem hiding this comment. I know it's unrelated to the changes, but seems like the title could just be:
Suggested change
There was a problem hiding this comment. And then the TOC entry at docs/docs/navigate/tools-diagnostics/toc.yml Line 139 in 6b7617a |
||||||
|
|
||||||
|
|
@@ -21,6 +21,30 @@ Each template may have additional options available. To show the additional opti | |||||
| In case the template supports multiple languages, this command will show help for the template in the default language. By combining it with the `--language` option, you can see the help for other languages: `dotnet new console --help --language F#`. | ||||||
| The templates that ship with the .NET SDK have the following additional options: | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| ## `buildprops` | ||||||
|
There was a problem hiding this comment. Since all of these sections are really about the options for each template, I feel like each template heading should be an H3, not an H2, to make them subheadings of |
||||||
|
|
||||||
| Creates a *Directory.Build.props* file for customizing MSBuild properties for an entire folder tree. For more information, see [Customize your build](/visualstudio/msbuild/customize-your-build). | ||||||
|
|
||||||
| - **`--inherit`** | ||||||
|
|
||||||
| If specified, adds an Import element for the closest *Directory.Build.props* file in the parent directory hierarchy. By default, *Directory.Build.props* files don't inherit from parent directories, so enabling this option allows you to build up a hierarchy of customizations folder-by-folder. | ||||||
|
|
||||||
| - **`--use-artifacts`** | ||||||
|
|
||||||
| If specified, adds a property to enable the artifacts output layout. This is a common pattern for projects that produce build artifacts, such as NuGet packages, that are placed in a common folder structure. For more information, see [Artifacts output layout](../sdk/artifacts-output.md). | ||||||
|
|
||||||
| *** | ||||||
|
|
||||||
| ## `buildtargets` | ||||||
|
|
||||||
| Creates a *Directory.Build.targets* file for customizing MSBuild targets and tasks for an entire folder tree. For more information, see [Customize your build](/visualstudio/msbuild/customize-your-build). | ||||||
|
|
||||||
| - **`--inherit`** | ||||||
|
|
||||||
| If specified, adds an Import element for the closest *Directory.Build.targets* file in the parent directory hierarchy. By default, *Directory.Build.targets* files don't inherit from parent directories, so enabling this option allows you to build up a hierarchy of customizations folder-by-folder. | ||||||
|
|
||||||
| *** | ||||||
|
|
||||||
| ## `console` | ||||||
|
|
||||||
| - **`-f|--framework <FRAMEWORK>`** | ||||||
|
|
@@ -901,6 +925,15 @@ API Controller with or without read/write actions. | |||||
| The roll-forward policy to use when selecting an SDK version, either as a fallback when a specific SDK version is missing or as a directive to use a later version. | ||||||
| For more information, see [global-json](global-json.md#rollforward). | ||||||
|
|
||||||
| ## `sln` | ||||||
|
|
||||||
| Creates an empty solution file containing no projects. | ||||||
|
|
||||||
| > [!NOTE] | ||||||
| > In .NET SDK 9.0.200 and later, this template supports a `--format` option to choose between `sln` and `slnx` formats. Starting with .NET 10, the default format will be `slnx`. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| *** | ||||||
|
|
||||||
| ## `editorconfig` | ||||||
|
|
||||||
| Creates an *.editorconfig* file for configuring code style preferences. | ||||||
|
|
||||||
|
There was a problem hiding this comment. Should the templates in the table be listed alphabetically to make it easier to find what you're looking for? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.