Skip to content

Commit

Permalink
[Blazor] Logging - comments for "magic numbers" (#32455)
Browse files Browse the repository at this point in the history
  • Loading branch information
hakenr committed Apr 29, 2024
1 parent fb884a2 commit 0c03008
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions aspnetcore/blazor/fundamentals/logging.md
Expand Up @@ -704,7 +704,7 @@ Blazor Web App:
Blazor.start({
circuit: {
configureSignalR: function (builder) {
builder.configureLogging(2);
builder.configureLogging(2); // LogLevel.Information
}
}
});
Expand All @@ -720,14 +720,17 @@ Blazor Server:
<script>
Blazor.start({
configureSignalR: function (builder) {
builder.configureLogging(2);
builder.configureLogging(2); // LogLevel.Information
}
});
</script>
```

In the preceding example, the `{BLAZOR SCRIPT}` placeholder is the Blazor script path and file name. For the location of the script, see <xref:blazor/project-structure#location-of-the-blazor-script>.

> [!NOTE]
> Using an integer to specify the logging level in Example 2, often referred to as a *magic number* or *magic constant*, is considered a poor coding practice because the integer doesn't clearly identify the logging level when viewing the source code. If minimizing the bytes transferred to the browser is a priority, using an integer might be justified (consider removing the comment in such cases).
For more information on Blazor startup (`Blazor.start()`), see <xref:blazor/fundamentals/startup>.

## SignalR client logging with app configuration
Expand Down

0 comments on commit 0c03008

Please sign in to comment.