Fred Tingaud 51369b610e
Make sure that includes are always surrounded by empty lines (#2270)
When an include is not surrounded by empty lines, its content is inlined
on the same line as the adjacent content. That can lead to broken tags
and other display issues.
This PR fixes all such includes and introduces a validation step that
forbids introducing the same problem again.
2023-06-22 10:38:01 +02:00

63 lines
1.1 KiB
Plaintext

== Why is this an issue?
include::../description.adoc[]
=== Noncompliant code example
[source,csharp]
----
using System.Web.Mvc;
public class HomeController : Controller
{
public ActionResult Article()
{
ViewBag.Title = "Title"; // Noncompliant, model should be used
ViewData["Text"] = "Text"; // Noncompliant, model should be used
return View();
}
}
----
=== Compliant solution
[source,csharp]
----
using System.Web.Mvc;
public class ArticleModel
{
public string Title { get; set; }
public string Text { get; set; }
}
public class HomeController : Controller
{
public ActionResult Article()
{
var model = new ArticleModel { Title = "Title", Text = "Text" };
return View(model);
}
}
----
include::../see.adoc[]
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
include::../highlighting.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]