dotnet / dotnet/dotnet-api-docs

System.IO.Ports.SerialPort defaults are undocumented

Offen
#803 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
.net/prod area-System.IO.Ports Pri2 untriaged
Vorherrschende Sprache
C#
Sterne
950
Forks
1.7k
Ø Merge
2 T. 19 Std.
Gemergte PRs (30 T.)
52

Beschreibung

The documentation might mention defaults for various serial port parameters. For example, if handshake is unspecified as is true in various constructors, what value does it assume?
I found defaults in the source code starting here:
https://github.com/Microsoft/referencesource/blob/master/System/sys/system/IO/ports/SerialPort.cs#L43

---
#### Document Details

⚠ *Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.*

* ID: fa765d00-19f8-74e4-4be1-1d7f1e7dc6ce
* Version Independent ID: 260749e3-69c6-a370-89b0-4f90d944fac7
* Content: [SerialPort Class (System.IO.Ports)](https://docs.microsoft.com/en-us/dotnet/api/system.io.ports.serialport?view=netcore-2.0)
* Content Source: [xml/System.IO.Ports/SerialPort.xml](https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.IO.Ports/SerialPort.xml)
* Product: **.net**
* GitHub Login: @mairaw
* Microsoft Alias: **mairaw**

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Prüfe xml/System.IO.Ports/SerialPort.xml zusammen mit dem referenzierten Quellcode System.IO.Ports/SerialPort.cs, beginnend mit den von SerialPort-Konstruktoren und -Parametern verwendeten Standardwerten. Dokumentiere die relevanten Standardwerte, einschließlich des nicht angegebenen Handshake-Werts, in der API-Referenz und verifiziere, dass die dokumentierten Werte mit dem Quellcode übereinstimmen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
42/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.