dotnet / dotnet/dotnet-api-docs

System.IO.StreamWriter Constructor with BufferSize Argument

オープン 初心者向け
#4,841 コメント 2 件 リアクション 1 件 担当者 0 名 GitHub で見る
area-System.IO Pri3 untriaged
主要言語
C#
スター
949
フォーク
1.7k
平均マージ
2日 19時間
マージ済み PR(30日)
52

説明

The documentation for `public StreamWriter (System.IO.Stream stream, System.Text.Encoding encoding, int bufferSize)` states that an `ArgumentOutOfRangeException` will be thrown if _`bufferSize` is negative_. That statement is incorrect as it implies that a value of zero will not throw an exception. The corresponding documentation for `public StreamReader (System.IO.Stream stream, System.Text.Encoding encoding, bool detectEncodingFromByteOrderMarks, int bufferSize)` is correct as it states that an `ArgumentOutOfRangeException` will be thrown if _`bufferSize` is less than or equal to zero._

[public StreamWriter (System.IO.Stream stream, System.Text.Encoding encoding, int bufferSize)](https://docs.microsoft.com/en-us/dotnet/api/system.io.streamwriter.-ctor?view=netframework-4.8#System_IO_StreamWriter__ctor_System_IO_Stream_System_Text_Encoding_System_Int32_)

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

リンク先の StreamWriter コンストラクターのドキュメントを開き、bufferSize の例外に関する記述を、対応する StreamReader コンストラクターのドキュメントと比較します。ドキュメントに記載された条件が API の動作と一致していること、およびレンダリングされたページにゼロ値の場合が明確に記載されていることを確認します。誤った記述が修正された時点で issue は完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
csharp
領域
documentation
issue の種類
ドキュメント
難易度
1/5
見積もり時間
1時間未満
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
62/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。