Каков наилучший способ создания HTML в коде C #? [закрыто]

У меня есть убеждение, что разметка должна оставаться в разметке, а не в коде позади.

Я попал в ситуацию, когда считаю приемлемым встроить HTML в код позади. Я хотел бы иметь некоторое согласие относительно того, каковы лучшие практики или должны быть.

Когда допустимо встраивать html в код? Каков наилучший метод для создания этого HTML? (пример: Strings, StringBuilder, HTMLWriter и т. д.)

Использование чего-то вроде Razor здесь не применимо? Потому что, если вы делаете много html-генерации с использованием механизма представления, это может сделать это намного проще. Он также был создан для использования вне ASP.NET.

Однако иногда это не то, что вам нужно. Рассматривали ли вы использование класса TagBuilder, который является частью .net (mvc)? В System.Web.UI также есть HtmlWriter (для веб-форм). Я бы порекомендовал один из них, если вы делаете Controlsили Html Helpers.

Я бы использовал Html Agility Pack, чтобы собрать HTML, а затем записать его в текстовый файл.

Много человеко-часов ушло на то, чтобы сделать Html Agility Pack надежным и совместимым с HTML.

Я думаю, что это даже включает пример приложения, которое генерирует HTML.

С домашней страницы:

Примеры приложений:

Исправление страницы или генерация. Вы можете исправить страницу так, как вы хотите, изменить DOM, добавить узлы, скопировать узлы, ну ... вы называете это.

Я бы использовал htmltags для создания HTML.

Пример:

var tag = new HtmlTag("span")
    .Text("Hello & Goodbye")
    .AddClass("important")
    .Attr("title", "Greetings")

А потом CSQuery, если я захочу разобрать HTML

Пример:

dom.Select("div > span")
    .Eq(1)
    .Text("Change the text content of the 2nd span child of each div");

Конечно, есть библиотеки, такие как HTML Agility Pack, которые могут помочь вам в этих начинаниях.

Если вы действительно не хотите использовать существующую библиотеку и хотите простой, неуклюжий код, мне нравится идея абстрагировать некоторые варианты поведения, как указано в предыдущем ответе. Мне также нравится идея использования базового StringBuilder, а не строки по нескольким причинам:

1. Строки менее эффективны, чем строитель строк
2. StringBuilder - это индексируемая структура данных,

Если мне не нужен массивно сконструированный HTML-движок, я бы создал простой, интуитивно понятный интерфейс

AddLineBreak();
AddSimpleTag(string tagName);
AddSimpleTagAt(string tagName, string content, int index);
Output();

Если вы в конечном итоге используете только строки, не забудьте экранировать все зарезервированные символы HTML в ваших выходных данных.

&    &
>    >
<    &lt;
"    &quot;
'    &apos;

Однако я рекомендую использовать HTML-класс или библиотеку вместо прямой работы со строками. HTMLWriter выглядит довольно хорошим началом.

Спустя почти два года после первоначального поста - вот решение, которое хорошо сработало для меня. В целевой документ я помещаю следующее:

<table>    
    <%:theHtmlTableMomToldYouAbout() %>    //# Where I want my rows of table data to go
</table>

вызываемая функция выглядит так:

    public HtmlString theHtmlTableMomToldYouAbout()
    {
        string content = "";
        HtmlString theEnvelopePlease = null;

        for (int i = 0; i < 5; i++)
        {
            content = content + "<tr><td>The Number Is: " + i + "</td></tr>";
        }
        theEnvelopePlease = new HtmlString(content);
        return theEnvelopePlease;      
    }

И результат в браузере будет таким, как и ожидалось:
Число: 0
Число: 1
Число: 2
Число: 3
Число: 4

Когда я иду к источнику, я нахожу следующее:

<table>
    <tr><td>The Number Is: 0</td></tr>
    <tr><td>The Number Is: 1</td></tr>
    <tr><td>The Number Is: 2</td></tr>
    <tr><td>The Number Is: 3</td></tr>
    <tr><td>The Number Is: 4</td></tr>
</table>

ПЫЛАТЬ!

var html = "";
html += "<table class='colorful'>";
foreach(var item in collection) {
     html += "<tr>";
     html += "<td class='boldCell'>" + item.PropWhatever + "</td>";
     // more cells here as needed
     html += "</tr>";
}
html += "</table>";
placeholder1.InnerHtml = html;

Я, вероятно, буду за это опускаться, но как бывший дизайнер, который должен был настроить HTML в коде, прежде чем я действительно много знал о .NET, приведенный выше код был намного проще для понимания, чем методы, которые абстрагируют создание HTML. Если вы думаете, что дизайнеру может понадобиться настроить ваш HTML, используйте простые строки, подобные этой.

Я вижу, что многие разработчики упускают при написании HTML в коде то, что в HTML допускаются одинарные или двойные кавычки для атрибутов. Таким образом, вместо экранирования всех кавычек в коде (который выглядит неуклюже как бродяга для не инициированного), просто используйте одинарные кавычки для кавычек html внутри ваших строк.

FINE. Все, что вы связываете ненавистников, связывают мою репутацию. Вот «правильный» способ сделать это без конкатенации строк, но я придерживаюсь своего мнения, что любая обычная страница с обычными таблицами не будет представлять проблем с производительностью за пределами какой-то нелепой Google-подобной шкалы:

var sb = new System.Text.StringBuilder();
sb.Append("<table class='colorful'>");
foreach (var item in collection)
{
     sb.Append("<tr>");
     sb.Append("<td class='boldCell'>" + item.PropWhatever + "</td>");
     // more cells here as needed
     sb.Append("</tr>");
}
sb.Append("</table>");
placeholder1.InnerHtml = sb.ToString();