Skip to content

Commit

Permalink
Updates per revised guidance on adding a copilot section to docs (#43994
Browse files Browse the repository at this point in the history 
)

* Update parse-strings-using-split.md per revised guidance on adding a copilot section to docs

* Update how-to-convert-a-string-to-a-number.md

* Delete docs/csharp/programming-guide/types/media/how-to-convert-a-string-to-a-number directory

* Delete docs/csharp/how-to/media/parse-strings-using-split directory

* Update docs/csharp/how-to/parse-strings-using-split.md

Co-authored-by: Genevieve Warren <[email protected]>

* Fix example.

* Remove extra newlines

* Modify prompt example to use Bill's suggested prompt

---------

Co-authored-by: Genevieve Warren <[email protected]>
  • Loading branch information
@anandmeg @gewarren
anandmeg and gewarren authored Dec 18, 2024
1 parent ddd0d3c commit 8fb4a43
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 105 deletions.
Binary file removed ...arp/how-to/media/parse-strings-using-split/github-copilot-chat-string-split.png
View file
Binary file not shown.
62 changes: 10 additions & 52 deletions docs/csharp/how-to/parse-strings-using-split.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ The <xref:System.String.Split%2A?displayProperty=nameWithType> method creates an

[!INCLUDE[interactive-note](~/includes/csharp-interactive-note.md)]

> [!TIP]
> You can use AI assistance to [split a string with GitHub Copilot](#use-github-copilot-to-split-a-string).
## String.Split examples

The following code splits a common phrase into an array of strings for each word.
Expand Down Expand Up @@ -49,64 +52,19 @@ Consecutive instances of any separator produce the empty string in the output ar

## Use GitHub Copilot to split a string

You can use GitHub Copilot in your IDE to generate code to split strings using `String.Split` in C#.

If you're using [Visual Studio 2022 version 17.8 or later](/visualstudio/releases/2022/release-notes), you can try the AI-driven [GitHub Copilot in Visual Studio](/visualstudio/ide/visual-studio-github-copilot-install-and-states) to generate code to split an input string into substrings based on one or more delimiters. Submit your question as a prompt in the Copilot chat window, as in the following example. You can also submit prompts using [inline chat](/visualstudio/ide/visual-studio-github-copilot-chat#ask-questions-in-the-inline-chat-view) in the editor window itself.

> [!NOTE]
> GitHub Copilot is powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions. For more information about the general use of GitHub Copilot, product impact, human oversight, and privacy, see [GitHub Copilot FAQs](https://github.com/features/copilot#faq).
You can use GitHub Copilot in your IDE to generate code to split strings using `String.Split` in C#. You can customize the prompt to use strings and delimiters per your requirements.

The following text shows an example prompt for Copilot Chat:

> Generate C# code to use Split.String split a string into substrings. Input string is "You win some. You lose some." Delimiters are space and period. Provide example output.
You can customize the prompt to use strings and delimiters per your requirements.

You can use chat features, such as [slash commands, references to files, methods, or classes, and threads](/visualstudio/ide/copilot-chat-context), to set intent and get better answers with scoped context. For an existing file that's open in the IDE, you can prompt GitHub Copilot using inline chat with `/generate code to split string1 in #Filename by delimiter spaces`.

The following output shows an example Copilot Chat response:

```output
Here is an example of how you can use the Split method in C# to split the string "You win some. You lose some." using space and period as delimiters:
using System;
class Program
{
static void Main()
{
string input = "You win some. You lose some.";
char[] delimiters = new char[] { ' ', '.' };
string[] substrings = input.Split(delimiters, StringSplitOptions.RemoveEmptyEntries);
foreach (string substring in substrings)
{
Console.WriteLine(substring);
}
}
}
**Example Output**
You
win
some
You
lose
some
```copilot-prompt
Generate C# code to use Split.String to split a string into substrings.
Input string is "You win some. You lose some." Delimiters are space and period.
Provide example output.
```

When Copilot returns a code block, the response includes options to copy the code, insert the code into a new file, or preview the code output.

> [!NOTE]
> Your results might be different from what's shown in the example responses. AI models are non-deterministic, which means that they can return different responses when asked the same question. This might be due to additional learning and adaption over time, language variation, changes in context, such as your chat history, and more.
:::image type="content" source="./media/parse-strings-using-split/github-copilot-chat-string-split.png" alt-text="Screenshot that shows using GitHub Copilot Chat in Visual Studio to split a string into substrings." lightbox="./media/parse-strings-using-split/github-copilot-chat-string-split.png":::

For more information, see:
GitHub Copilot is powered by AI, so surprises and mistakes are possible. For more information, see [Copilot FAQs](https://aka.ms/copilot-general-use-faqs).

* [GitHub Copilot Trust Center](https://resources.github.com/copilot-trust-center/)
* [GitHub Copilot in Visual Studio](/visualstudio/ide/visual-studio-github-copilot-install-and-states)
* [GitHub Copilot in VS Code](https://code.visualstudio.com/docs/copilot/overview)
Learn more about [GitHub Copilot in Visual Studio](/visualstudio/ide/visual-studio-github-copilot-install-and-states) and [GitHub Copilot in VS Code](https://code.visualstudio.com/docs/copilot/overview).

## See also

Expand Down
62 changes: 9 additions & 53 deletions docs/csharp/programming-guide/types/how-to-convert-a-string-to-a-number.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@ You convert a `string` to a number by calling the `Parse` or `TryParse` method f
It's slightly more efficient and straightforward to call a `TryParse` method (for example, [`int.TryParse("11", out number)`](xref:System.Int32.TryParse%2A)) or `Parse` method (for example, [`var number = int.Parse("11")`](xref:System.Int32.Parse%2A)). Using a <xref:System.Convert> method is more useful for general objects that implement <xref:System.IConvertible>.

You use `Parse` or `TryParse` methods on the numeric type you expect the string contains, such as the <xref:System.Int32?displayProperty=nameWithType> type. The <xref:System.Convert.ToInt32%2A?displayProperty=nameWithType> method uses <xref:System.Int32.Parse%2A> internally. The `Parse` method returns the converted number; the `TryParse` method returns a boolean value that indicates whether the conversion succeeded, and returns the converted number in an `out` parameter. If the string isn't in a valid format, `Parse` throws an exception, but `TryParse` returns `false`. When calling a `Parse` method, you should always use exception handling to catch a <xref:System.FormatException> when the parse operation fails.


> [!TIP]
> You can use AI assistance to [convert a string to a number with GitHub Copilot](#use-github-copilot-to-convert-a-string-to-a-number).
## Call Parse or TryParse methods

The `Parse` and `TryParse` methods ignore white space at the beginning and at the end of the string, but all other characters must be characters that form the appropriate numeric type (`int`, `long`, `ulong`, `float`, `decimal`, and so on). Any white space within the string that forms the number causes an error. For example, you can use `decimal.TryParse` to parse "10", "10.3", or " 10 ", but you can't use this method to parse 10 from "10X", "1 0" (note the embedded space), "10 .3" (note the embedded space), "10e1" (`float.TryParse` works here), and so on. A string whose value is `null` or <xref:System.String.Empty?displayProperty=nameWithType> fails to parse successfully. You can check for a null or empty string before attempting to parse it by calling the <xref:System.String.IsNullOrEmpty%2A?displayProperty=nameWithType> method.
Expand Down Expand Up @@ -55,61 +58,14 @@ The following example calls the <xref:System.Convert.ToInt32%28System.String%29?

## Use GitHub Copilot to convert a string to a number

You can use GitHub Copilot in your IDE to generate code to convert a string to a number in C#.

If you're using [Visual Studio 2022 version 17.8 or later](/visualstudio/releases/2022/release-notes), you can try the AI-driven [GitHub Copilot in Visual Studio](/visualstudio/ide/visual-studio-github-copilot-install-and-states) to generate code to convert a string to a number. Submit your question as a prompt in the Copilot chat window, as in the following example. You can also submit prompts using [inline chat](/visualstudio/ide/visual-studio-github-copilot-chat#ask-questions-in-the-inline-chat-view) in the editor window itself.

> [!NOTE]
> GitHub Copilot is powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions. For more information about the general use of GitHub Copilot, product impact, human oversight, and privacy, see [GitHub Copilot FAQs](https://github.com/features/copilot#faq).
You can use GitHub Copilot in your IDE to generate C# code to convert a string to a number. You can customize the prompt to use a string per your requirements.

The following text shows an example prompt for Copilot Chat:

> Generate C# code to convert the string "123" to a number using TryParse. Provide example output.
You can customize the prompt to use a string per your requirements.

You can use chat features, such as [slash commands, references to files, methods, or classes, and threads](/visualstudio/ide/copilot-chat-context), to set intent and get better answers with scoped context. For an existing file that's open in the IDE, you can prompt GitHub Copilot using inline chat with `/generate code to convert the string string1 in #Filename to a number`.

The following output shows an example Copilot Chat response:

```output
Here is a C# code snippet to convert the string "123" to a number using TryParse:
using System;
class Program
{
static void Main()
{
string numberString = "123";
int number;
bool success = int.TryParse(numberString, out number);
if (success)
{
// Example output
Console.WriteLine("The converted number is: " + number);
}
else
{
Console.WriteLine("Conversion failed.");
}
}
}
When you run this code, the output will be:
The converted number is: 123
```copilot-prompt
Show me how to parse a string as a number, but don't throw an exception if the input string doesn't represent a number.
```

When Copilot returns a code block, the response includes options to copy the code, insert the code into a new file, or preview the code output.

> [!NOTE]
> Your results might be different from what's shown in the example responses. AI models are non-deterministic, which means that they can return different responses when asked the same question. This might be due to additional learning and adaption over time, language variation, changes in context, such as your chat history, and more.
:::image type="content" source="./media/how-to-convert-a-string-to-a-number/github-copilot-chat-convert-string-to-number.png" alt-text="Screenshot that shows using GitHub Copilot Chat in Visual Studio to convert a string to a number." lightbox="./media/how-to-convert-a-string-to-a-number/github-copilot-chat-convert-string-to-number.png":::

For more information, see:
GitHub Copilot is powered by AI, so surprises and mistakes are possible. For more information, see [Copilot FAQs](https://aka.ms/copilot-general-use-faqs).

* [GitHub Copilot Trust Center](https://resources.github.com/copilot-trust-center/)
* [GitHub Copilot in Visual Studio](/visualstudio/ide/visual-studio-github-copilot-install-and-states)
* [GitHub Copilot in VS Code](https://code.visualstudio.com/docs/copilot/overview)
Learn more about [GitHub Copilot in Visual Studio](/visualstudio/ide/visual-studio-github-copilot-install-and-states) and [GitHub Copilot in VS Code](https://code.visualstudio.com/docs/copilot/overview).
Binary file removed ...o-convert-a-string-to-a-number/github-copilot-chat-convert-string-to-number.png
View file
Binary file not shown.

0 comments on commit 8fb4a43

Please sign in to comment.