Ensuring consistency and clarity in .NET Framework documentation and UI elements.
The .NET Framework style guide is built upon these fundamental principles:
Use semantic HTML tags for headings. Font: 'Segoe UI', sans-serif.
Standard paragraph text. Use clear and concise language. Maintain adequate line spacing for readability.
This is an example of a paragraph. It explains concepts and provides details. Keep sentences and paragraphs focused on a single idea.
Use the <code> tag for inline code and the <pre><code> block for multi-line code.
public class Greeter
{
public void SayHello(string name)
{
Console.WriteLine($"Hello, {name}!");
}
}
Code should be formatted with proper indentation and syntax highlighting (if implemented).
Links should be clearly identifiable and use descriptive text. Standard link color is #0078d4.
This is a primary link. On hover, it turns to #d1343c and underlines.
Each page should follow a consistent structure:
Use distinct blocks for different types of content, such as informational sections, examples, and warnings.
This is an informational block. Use it to highlight important details or provide context.
This is a warning block. Use it to alert users to potential issues or deprecated features.
Use tabs to organize related content without overwhelming the user.
This is the content displayed when Tab 1 is active. It might contain explanations, code examples, or other relevant information.
<div id="tab1" class="tab-content active">...</div>This section demonstrates the second tab's content. It's a great place for alternative examples or related documentation.
Finally, the content for the third tab. Tabs help keep complex pages organized and improve user experience.
Input fields should be clearly labeled and have sufficient spacing.