Skip to content

Improve Volatile class documentation #2503

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BillWagner merged 2 commits into from
May 28, 2019
Merged

Improve Volatile class documentation #2503

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9241a9e
Update Volatile.xml
MSDN-WhiteKnight May 26, 2019
adcdea2
Update Volatile.xml
MSDN-WhiteKnight May 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions xml/System.Threading/Volatile.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,11 @@
> [!NOTE]
> Calling one of these methods affects only a single memory access. To provide effective synchronization for a field, all access to the field must use <xref:System.Threading.Volatile.Read%2A?displayProperty=nameWithType> and <xref:System.Threading.Volatile.Write%2A?displayProperty=nameWithType>.

- In C#, using the `volatile` modifier on a field guarantees that every access to that field uses the <xref:System.Threading.Volatile.Read%2A?displayProperty=nameWithType> and <xref:System.Threading.Volatile.Write%2A?displayProperty=nameWithType> methods, but the `volatile` modifier cannot be applied to array elements. The <xref:System.Threading.Volatile.Read%2A?displayProperty=nameWithType> and <xref:System.Threading.Volatile.Write%2A?displayProperty=nameWithType> methods can be used on array elements.
- In C#, using the `volatile` modifier on a field guarantees that every access to that field is a volatile memory operation, but the `volatile` modifier cannot be applied to array elements. The <xref:System.Threading.Volatile.Read%2A?displayProperty=nameWithType> and <xref:System.Threading.Volatile.Write%2A?displayProperty=nameWithType> methods can be used on array elements.

]]></format>
</remarks>
<related type="Article" href="/dotnet/csharp/language-reference/keywords/volatile">volatile keyword (C# Reference)</related>
</Docs>
<Members>
<MemberGroup MemberName="Read">
Expand Down Expand Up @@ -1639,4 +1640,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>