Параметр, предоставляющий дополнительную информацию о том, как браузер должен обрабатывать текущий тег
Обновлено: 21.11.2024
Создает HTML-страницы документации API из исходных файлов Java.
Краткий обзор
Имена пакетов, которые вы хотите задокументировать, разделенные пробелами, например java.lang java.lang.reflect java.awt . Если вы хотите также задокументировать подпакеты, используйте параметр -subpackages, чтобы указать пакеты.
По умолчанию javadoc ищет указанные пакеты в текущем каталоге и подкаталогах. Используйте параметр -sourcepath, чтобы указать список каталогов, в которых следует искать пакеты.
исходные файлы
Имена исходных файлов Java, которые вы хотите задокументировать, разделенные пробелами, например Class.java Object.java Button.java . По умолчанию javadoc ищет указанные классы в текущем каталоге. Однако вы можете указать полный путь к файлу класса и использовать подстановочные знаки, например, /home/src/java/awt/Graphics*.java . Вы также можете указать путь относительно текущего каталога.
Параметры командной строки, разделенные пробелами. См. Параметры.
Имена файлов, которые содержат список параметров команды javadoc, имена пакетов и имена исходных файлов в любом порядке.
Описание
Команда javadoc анализирует объявления и комментарии к документации в наборе исходных файлов Java и создает соответствующий набор HTML-страниц, описывающих (по умолчанию) общедоступные и защищенные классы, вложенные классы (но не анонимные внутренние классы), интерфейсы. , конструкторы, методы и поля. Вы можете использовать команду javadoc для создания документации API или документации по реализации для набора исходных файлов.
Команду javadoc можно запускать для целых пакетов, отдельных исходных файлов или и того, и другого. При документировании целых пакетов вы можете либо использовать параметр -subpackages для рекурсивного обхода каталога и его подкаталогов, либо передать явный список имен пакетов. Когда вы документируете отдельные исходные файлы, передайте список имен исходных файлов Java. См. простые примеры.
Соответствие
Стандартный доклет не проверяет содержимое комментариев к документации на соответствие и не пытается исправить какие-либо ошибки в комментариях к документации. Помните о проблемах, которые могут возникнуть при создании несоответствующих выходных данных или выходных данных, содержащих исполняемый контент, например JavaScript, при выполнении команды javadoc. В стандартном доклете есть опция -Xdoclint, помогающая обнаруживать распространенные проблемы в комментариях к документации; тем не менее, также рекомендуется проверить сгенерированный вывод с помощью любых соответствующих инструментов проверки соответствия.
Дополнительную информацию о требованиях соответствия для документов HTML5 см. в разделе Требования соответствия в спецификации HTML5. Дополнительные сведения о проблемах безопасности, связанных с веб-страницами, см. в документе Open Web Application Security Project (OWASP).
Обработка исходных файлов
Команда javadoc обрабатывает файлы, оканчивающиеся на исходный код, и другие файлы, описанные в разделе Исходные файлы. Если вы запустите команду javadoc, передав имена отдельных исходных файлов, то сможете точно определить, какие исходные файлы обрабатываются. Однако это не то, как большинство разработчиков хотят работать, потому что проще передать имена пакетов. Команду javadoc можно запустить тремя способами без явного указания имен исходных файлов. Вы можете передавать имена пакетов, использовать параметр -subpackages или использовать подстановочные знаки с именами исходных файлов. В этих случаях команда javadoc обрабатывает исходный файл только в том случае, если файл соответствует всем следующим требованиям:
Префикс имени файла (с удаленным .java) является допустимым именем класса.
Имя пути относительно корня исходного дерева является допустимым именем пакета после преобразования разделителей в точки.
Утверждение пакета содержит допустимое имя пакета.
Обработка ссылок
Во время выполнения команда javadoc добавляет перекрестные ссылки на имена пакетов, классов и элементов, которые документируются как часть этого выполнения. Ссылки появляются в следующих местах. Описание тегов @ см. в разделе Теги Javadoc.
Объявления (типы возвращаемых значений, типы аргументов и типы полей).
РазделыСм. также, созданные на основе тегов @see.
Встроенный текст, сгенерированный из тегов.
Имена исключений, сгенерированные из тегов @throws.
Определено ссылками на члены интерфейса и ссылками Overrides на члены класса. См. Наследование комментариев к методам.
Сводные таблицы со списком пакетов, классов и членов.
Деревья наследования пакетов и классов.
Вы можете добавить ссылки на существующий текст для классов, не включенных в командную строку (но сгенерированных отдельно), с помощью параметров -link и -linkoffline.
Сведения об обработке
Команда javadoc создает один полный документ при каждом запуске.Он не выполняет добавочные сборки, которые изменяют или напрямую включают результаты предыдущих запусков. Однако команда javadoc может ссылаться на результаты других запусков.
Реализация команды javadoc требует компилятора Java и зависит от него. Команда javadoc вызывает часть команды javac для компиляции объявлений и игнорирования реализации членов. Команда javadoc создает богатое внутреннее представление классов, которое включает иерархию классов и использует отношения для создания HTML. Команда javadoc также выбирает предоставленную пользователем документацию из комментариев к документации в исходном коде. См. комментарии к документации.
Команда javadoc выполняется с исходными файлами, которые представляют собой чистые файлы-заглушки без тел методов. Это означает, что вы можете писать комментарии к документации и запускать команду javadoc на ранних этапах проектирования до реализации API.
Использование компилятора гарантирует точное соответствие вывода HTML фактической реализации, которая может опираться на неявный, а не явный исходный код. Например, команда javadoc документирует конструкторы по умолчанию, которые присутствуют в скомпилированных файлах классов, но отсутствуют в исходном коде.
Во многих случаях команда javadoc позволяет создавать документацию для исходных файлов с неполным или ошибочным кодом. Вы можете создать документацию до того, как будут выполнены все операции по отладке и устранению неполадок. Команда javadoc выполняет примитивную проверку комментариев к документации.
Как правило, создаваемые вами классы должны быть загружены либо как расширение, либо по пути класса команды javadoc.
Доклеты Javadoc
С помощью доклетов можно настроить содержимое и формат вывода команды javadoc. Команда javadoc имеет встроенный доклет по умолчанию, называемый стандартным доклетом, который генерирует документацию API в формате HTML. Вы можете изменить или создать подкласс стандартного доклета или написать свой собственный доклет для создания HTML, XML, MIF, RTF или любого другого выходного формата, который вы хотите.
Если пользовательский доклет не указан с параметром -doclet, команда javadoc использует стандартный доклет по умолчанию. Команда javadoc имеет несколько параметров, которые доступны независимо от используемого доклета. Стандартный доклет добавляет дополнительный набор параметров командной строки. См. Параметры.
Исходные файлы
Команда javadoc генерирует выходные данные из исходных файлов следующих типов: исходные файлы на языке Java для классов ( .java ), файлы комментариев к пакетам, файлы обзорных комментариев и различные необработанные файлы. В этом разделе также описываются тестовые файлы и файлы шаблонов, которые также могут находиться в исходном дереве, но которые вы не хотите документировать.
Исходные файлы класса
Каждый класс или интерфейс и его члены могут иметь собственные комментарии к документации, содержащиеся в исходном файле. См. комментарии к документации.
Файлы комментариев к пакету
Каждый пакет может иметь свой собственный комментарий к документации, содержащийся в его собственном исходном файле, который команда javadoc объединяет с созданной страницей сводки пакета. Обычно вы включаете в этот комментарий любую документацию, относящуюся ко всему пакету.
Чтобы создать файл комментариев пакета, вы можете поместить свои комментарии в один из следующих файлов:
Файл package-info.java может содержать объявление пакета, аннотации пакета, комментарии к пакету и теги Javadoc. Этот файл является предпочтительным.
Файл package.html содержит только комментарии к пакету и теги Javadoc. Аннотаций пакетов нет.
Пакет может иметь один файл package.html или один файл package-info.java, но не оба вместе. Поместите любой файл в каталог пакета в дереве исходных текстов вместе с вашими исходными файлами.
Файл package-info.java
Файл package-info.java может содержать комментарий к пакету следующей структуры. Комментарий помещается перед объявлением пакета.
Примечание. Разделители комментариев /** и */ должны присутствовать, но начальные звездочки в промежуточных строках можно не использовать.
Файл package.html
Файл package.html может содержать комментарий к пакету следующей структуры. Комментарий помещается в элемент.
Файл package.html представляет собой обычный HTML-файл и не содержит объявления пакета. Содержимое файла комментариев к пакету записывается в формате HTML за одним исключением. Комментарий к документации не должен включать разделители комментариев /** и */ или начальные звездочки. При написании комментария сделайте первое предложение кратким изложением пакета и не помещайте заголовок или любой другой текст между тегом и первым предложением. Вы можете включить теги пакета. Все теги блоков должны стоять после основного описания. Если вы добавляете тег @see в файл комментариев к пакету, он должен иметь полное имя.
Обработка файла комментариев
При запуске команды javadoc выполняется поиск файла комментариев к пакету.Если файл комментариев к пакету найден, команда javadoc выполняет следующие действия:
В IntelliJ IDEA вы можете увидеть, где и как символы, такие как теги, классы, поля, методы или функции, определены в вашем проекте. Для этой цели в среде IDE имеется всплывающее окно быстрого определения.
Чтобы просмотреть определение символа, выберите его в редакторе и нажмите Ctrl+Shift+I (или нажмите View | Quick Definition ).
Можно также, удерживая нажатой клавишу Ctrl, навести курсор на любой символ. IntelliJ IDEA отображает символ как ссылку и показывает его определение во всплывающей подсказке. Щелкните эту ссылку, чтобы перейти к определению символа.
Вы можете открыть определение в окне инструмента "Найти". Для этого щелкните значок в правом верхнем углу всплывающего окна и выберите Открыть в окне инструмента поиска .
Чтобы открыть исходный код определения для редактирования и закрыть всплывающее окно, щелкните значок , а затем выберите Изменить источник ( F4 ).
Для языков разметки IntelliJ IDEA извлекает определения символов из указанного DTD или схемы. Подробнее см. в разделе HTML и XML.
Определения типов
Функция быстрого определения типа позволяет просматривать определение типа переменных, полей, методов или любых других символов во всплывающем окне, не переключаясь с редактируемого кода.
Поместите курсор на символ, для которого вы хотите просмотреть определение типа, и выберите View | Быстрое определение типа .
Чтобы открыть исходный код определения для редактирования и закрыть всплывающее окно, щелкните значок , а затем выберите Изменить источник ( F4 ).
В IntelliJ IDEA нет сочетания клавиш по умолчанию для этого действия, но вы можете настроить его вручную в настройках. Дополнительные сведения о настройке пользовательских сочетаний клавиш см. в разделе Настройка сочетаний клавиш.
Информация о параметрах
Всплывающее окно «Информация о параметрах» показывает имена параметров в вызовах методов и функций. IntelliJ IDEA автоматически показывает всплывающее окно со всеми доступными сигнатурами методов в течение 1 секунды (1000 миллисекунд) после ввода открывающей скобки в редакторе или выбора метода из списка предложений.
Вы можете явным образом вызвать всплывающее окно, если оно закрылось или если ваша среда IDE настроена так, чтобы всплывающее окно не отображалось автоматически. Для этого нажмите Ctrl+P (или щелкните View | Parameter Info ).
Показать полные сигнатуры методов или функций
По умолчанию во всплывающем окне с информацией о параметрах отображаются простые подписи. Вы можете настроить IDE для отображения полных сигнатур, включая имена методов и возвращаемые типы.
В диалоговом окне «Настройки/Настройки» ( Ctrl+Alt+S ) выберите «Редактор | Общие | Завершение кода и установите флажок Показать полные сигнатуры методов.
Настроить всплывающее окно с информацией о параметре
В диалоговом окне «Настройки/Настройки» ( Ctrl+Alt+S ) выберите «Редактор | Общие | Завершение кода.
Во всплывающем окне Показать информацию о параметрах в . В поле миллисекунд укажите время в миллисекундах, по истечении которого должно появиться всплывающее окно.
Если вы не хотите, чтобы всплывающее окно появлялось автоматически, снимите флажок Показывать всплывающее окно с информацией о параметре в . флажок миллисекунды.
Подсказки по вкладкам
Подсказки-вкладыши — это специальные маркеры, которые появляются в редакторе и предоставляют дополнительную информацию о вашем коде, например имена параметров, ожидаемых вызываемым методом. Другие типы подсказок информируют вас об аннотациях, параметрах методов, использовании и т. д. (в зависимости от языка).
Некоторые подсказки включены по умолчанию.
Вы можете точно настроить подсказки вкладок в меню Настройки/Настройки | Редактор | Инкрустационные подсказки. Подробное объяснение того, что делает каждый тип, см. в разделе Подсказки вкладок.
Настройте список исключений для подсказок параметров
Если вы не хотите видеть подсказки параметров для определенных методов, вы можете настроить список с исключениями. По умолчанию список исключений содержит ряд предопределенных методов. Вы можете удалить метод из списка, чтобы увидеть подсказки для него, или добавить новые методы, чтобы скрыть их подсказки в редакторе.
В диалоговом окне «Настройки/Настройки» ( Ctrl+Alt+S ) выберите «Редактор | Inlay Hints и выберите нужный язык.
Выберите подсказки параметров в списке в средней части.
Параметры настройки подсказок становятся доступными справа.
Добавьте методы, для которых вы не хотите видеть подсказки, в раздел Список исключений….
Добавьте дела, для которых вы не хотите видеть подсказки, в раздел Список исключений…. Чтобы добавить вариант, щелкните встроенную подсказку в коде, нажмите клавиши ALT+ВВОД и выберите Не показывать подсказки для текущего метода .
Примените изменения и закройте диалоговое окно.
Краткая документация
Вы можете получить краткую информацию о любом символе прямо из редактора с помощью функции быстрой документации. Он показывает вам документацию по коду во всплывающем окне, когда вы наводите указатель мыши на элементы кода. Обратите внимание, что символ должен быть снабжен комментариями к документации, созданными в соответствии с разметкой Javadoc или документацией SDK.
Эта функция позволяет вам получить доступ как к загруженной документации, так и к внешней документации, для которой вы указываете только ее URL. Для получения информации о том, как добавить документацию по коду, чтобы ее можно было открывать во всплывающем окне, см.:
Быстрая документация во всплывающем окне
Просмотр быстрой документации во всплывающем окне
Наведите указатель мыши на нужный символ в редакторе.
Поместите курсор на символ и нажмите Ctrl+Q ( View | Quick Documentation ).
Снова нажмите Ctrl+Q, чтобы открыть эту документацию в окне инструмента "Документация".
Нажмите во всплывающем окне, чтобы изменить размер шрифта, отобразить панель инструментов быстрой документации или перейти к исходному коду.
Чтобы указать задержку, после которой должно появиться всплывающее окно, в диалоговом окне «Настройки/Настройки» ( Ctrl+Alt+S ) выберите «Редактор | Редактирование кода | Подсказки редактора и введите необходимое значение в поле Задержка всплывающей подсказки.
Отключить быструю документацию при наведении
По умолчанию всплывающее окно быстрой документации появляется при наведении указателя мыши на элементы кода. Вы можете настроить IDE для отображения всплывающего окна только после того, как вы явным образом вызовете функцию быстрой документации.
Нажмите во всплывающем окне и отключите параметр «Показывать при перемещении мыши».
В диалоговом окне «Настройки/Настройки» ( Ctrl+Alt+S ) выберите «Редактор | Редактирование кода | Быстрая документация и снимите флажок Показывать краткую документацию при наведении курсора.
В этом случае, чтобы просмотреть документацию по символу вставки, нажмите Ctrl+Q или выберите View | Быстрая документация из главного меню. Документация будет показана во всплывающем окне, но вы можете настроить IDE для ее немедленного отображения в окне инструмента.
Быстрая документация в окне инструмента
Просмотреть документацию в окне инструмента
При настройках по умолчанию нажатие Ctrl+Q ( View | Quick Documentation ) открывает всплывающее окно с быстрой документацией. Вы можете изменить настройки для просмотра документации в окне инструментов.
Во всплывающем окне быстрой документации нажмите и отключите параметр «Показывать всплывающее окно документации первым».
В окне инструментов "Документация" щелкните значок на панели инструментов окна инструментов и отключите параметр "Показывать всплывающее окно документации первым".
Сохранять документацию в окне инструментов
Вы можете открыть часть документации для определенного элемента кода в окне инструментов и продолжить просмотр документации для других элементов в текущем файле.
Поместите курсор на нужный элемент кода и нажмите Ctrl+Q . Если появится всплывающее окно, снова нажмите Ctrl+Q, чтобы переключиться в окно инструментов.
Символ звездочки ( * ) на вкладке документации означает, что вкладка не закреплена, поэтому ее содержимое будет заменено документацией для другого элемента кода, выбранного вами в редакторе.
Щелкните правой кнопкой мыши вкладку с документацией или щелкните значок на панели инструментов окна инструментов и включите параметр Сохранить эту документацию.
После этого текущая вкладка документации будет закреплена. Вы можете вернуться в редактор и просмотреть документацию по другим элементам кода, которая откроется во всплывающем окне или на новой вкладке в окне инструмента.
Нажмите Ctrl+F в окне инструмента "Документация", чтобы использовать текстовый поиск.
Когда вы просматриваете документацию по коду в окне инструментов, она отображается на незакрепленной вкладке (вкладка, отмеченная символом звездочки ( * ). Существует несколько способов работы с ней:
Вы можете просмотреть документацию, наведя указатель мыши на элементы кода.
Нажмите значок на панели инструментов окна инструментов и включите параметры «Показывать при перемещении мыши» и «Автообновление из источника».
Вы можете просматривать документацию, помещая курсор в символы в редакторе, щелкая их или перемещая курсор.
Нажмите значок на панели инструментов, отключите параметр "Показывать при перемещении мыши" и включите параметры автоматического обновления из источника.
Вы можете просмотреть документацию, поместив курсор на символ и нажав Ctrl+Q или выбрав Вид | Быстрая документация из главного меню.
Нажмите значок на панели инструментов окна инструментов, отключите параметры «Показывать при перемещении мыши» и «Автоматическое обновление из источника».
Внешняя документация
Внешняя документация открывает необходимую информацию в веб-браузере, чтобы вы могли одновременно переходить к соответствующим символам и сохранять информацию для дальнейшего использования. После того как вы настроите внешнюю документацию для своего проекта, вы также сможете просмотреть ее во всплывающем окне Quick Documentation.
Информацию о том, как настроить пути к библиотеке и внешней документации SDK, см. здесь:
Просмотр внешней документации
Чтобы просмотреть документацию по символу в курсоре в браузере, нажмите Shift+F1 или выберите Вид | Внешняя документация из главного меню.
Информация о типе
В IntelliJ IDEA тип выражения можно определить следующим образом:
Поместите курсор на нужный элемент кода и нажмите Ctrl+Shift+P (или выберите View | Type Info в главном меню).
Если доступно несколько выражений, выберите нужное во всплывающем меню и нажмите Enter .
Статические данные выражения
IntelliJ IDEA позволяет просматривать в редакторе статически известную информацию о любом выражении Java. Эта информация помогает понять сложный код с большим числом ветвлений и уточняет информацию о типе выражения.
Чтобы просмотреть статическую информацию о выражениях Java, поместите курсор на выражение и дважды нажмите Ctrl+Shift+P .
В этом примере действие статических данных Expression показывает, что тип списка на самом деле ArrayList , несмотря на то, что переменная объявлена как List , и в данной точке он по-прежнему пуст (размер = 0).
Советы по продуктивности
Чтобы скопировать текст всплывающей подсказки в буфер обмена, удерживайте клавишу Alt (в Linux удерживайте Ctrl+Alt ) и щелкните всплывающую подсказку.
Просмотр контекстной информации
Если текущее объявление метода или класса не отображается, его можно просмотреть во всплывающей подсказке, нажав Alt+Q .
HTML-теги
Это список тегов, используемых в языке HTML. Каждый тег начинается с открывающего тега (знак меньше) и заканчивается закрывающим тегом (знак больше). Многие теги имеют соответствующие закрывающие теги, которые идентичны, за исключением косой черты после открывающего тега. (Например, тег TITLE).
Некоторые теги принимают параметры, называемые атрибутами. Атрибуты даются после тега, разделенные пробелами. Некоторые атрибуты имеют эффект просто своим присутствием, за другими следует знак равенства и значение. (См., например, тег Anchor). Имена тегов и атрибутов не чувствительны к регистру: они могут быть в нижнем, верхнем или смешанном регистре с одинаковым значением. (В этом документе они обычно представлены в верхнем регистре.)
В настоящее время документы HTML передаются без обычных тегов кадрирования SGML, но если они включены, синтаксические анализаторы будут их игнорировать.
Название документа дается между тегами title: . Текст между открывающим и закрывающим тегами является заголовком гипертекстового узла. В любом узле должен быть только один заголовок. Он должен идентифицировать содержимое узла в довольно широком контексте и в идеале должен помещаться в одну строку.
Заголовок не является строго частью текста документа, но является атрибутом узла. Он не может содержать привязки, знаки абзаца или выделения. заголовок может использоваться для идентификации узла в списке истории, для маркировки окна, отображающего узел, и т. д. Обычно он не отображается в тексте самого документа. Сравните заголовки с заголовками .
Следующий идентификатор
Устарело: только браузер NeXT. Может быть проигнорировано. Этот тег принимает единственный атрибут, который является номером следующего числового идентификатора всего документа, который будет выделен (не очень хороший SGML). Обратите внимание, что при изменении документа старые идентификаторы привязок не должны использоваться повторно, так как в другом месте могут храниться ссылки, указывающие на них. Это читается и генерируется гипертекстовыми редакторами. Люди-писатели HTML обычно используют мнемонические альфа-идентификаторы. Программное обеспечение браузера может игнорировать этот тег. Пример использования:
Якоря задают адреса других документов в формате "от" по отношению к адресу текущего документа. Обычно адрес документа известен браузеру, потому что он использовался для доступа к документу. Однако, если документ отправлен по почте или каким-либо образом виден с более чем одним адресом (например, по имени файла, а также по каталожному номеру сервера имен библиотек), тогда браузеру необходимо знать базовый адрес, чтобы правильно вывести внешний адрес. адреса документов.
Формат этого тега еще не указан. В НАСТОЯЩЕЕ ВРЕМЯ НЕ ИСПОЛЬЗУЕТСЯ
Этот тег информирует читателя о том, что документ является индексным. Помимо чтения, читатель может использовать поиск по ключевым словам.
Формат: к узлу можно обратиться с помощью поиска по ключевому слову, добавив к адресу узла вопросительный знак, за которым следует список ключевых слов, разделенных знаком плюс. См. формат сетевого адреса .
Этот тег указывает, что весь последующий текст следует воспринимать буквально до конца файла. Обычный текст предназначен для представления так же, как пример текста XMP, с символами фиксированной ширины и значительными разрывами строк. Формат:
Этот тег позволяет эффективно читать остальную часть файла без синтаксического анализа. Его наличие — это оптимизация. Нет закрывающего тега.
<УЛ>Абзац
Этот тег указывает на новый абзац. Точное представление этого (отступ, интерлиньяж и т. д.) здесь не определено и может быть функцией других тегов, таблиц стилей и т. д. Формат просто
(В терминах SGML элементы абзаца передаются в свернутом виде).
Поддерживается несколько уровней (не менее шести) заголовков. Обратите внимание, что гипертекстовому документу обычно требуется меньше уровней заголовков, чем обычному документу, единственная структура которого определяется вложенностью заголовков. H1 — это самый высокий уровень заголовка, который рекомендуется для начала гипертекстового узла. Рекомендуется, чтобы первый заголовок был подходящим для читателя, который уже просматривает связанную информацию, в отличие от тега заголовка, который должен идентифицировать узел в более широком контексте.
Эти теги хранятся в соответствии с определением в руководстве CERN SGML. Их определение является полностью историческим и основано на наборе тегов AAP. Разница в том, что документы HTML позволяют завершать заголовки закрывающими тегами:
Заголовок второго уровня
Этот тег предназначен для информации об адресе, подписи и т. п., обычно в верхней или нижней части документа. как правило, это курсив и/или выравнивание по правому краю или с отступом. Формат: текстовый .
Выделение
Выделенные теги фраз могут встречаться в обычном тексте и могут быть вложены друг в друга. За каждым открывающим тегом должен следовать соответствующий закрывающий тег. В НАСТОЯЩЕЕ ВРЕМЯ НЕ ИСПОЛЬЗУЕТСЯ. . . и т. д.
Глоссарии
Глосарий (или список определений) – это список абзацев, каждый из которых имеет короткий заголовок рядом с ним. Помимо глоссариев, этот формат полезен для представления читателю набора именованных элементов. Формат следующий: Определение термина pagagraph Term2 Определение термина 2
Списки
Есть несколько основных тегов, которые необходимо добавить в каждый создаваемый документ HTML. В предыдущем разделе вы создали новый файл с именем index.html. В текущем уроке вы добавите в этот файл несколько основных необходимых тегов, тем самым начав создание своего портфолио. Эти базовые теги служат шаблоном для любой веб-страницы.
Результаты учащегося
По завершении этого упражнения:
- вы изучите основные теги, необходимые для всех HTML-документов, и сможете создать пустую HTML-страницу со всеми необходимыми тегами.
Действия
- Откройте программу текстового редактора и перейдите к папке «портфолио», которую вы создали на уроке «Подготовка к программированию». Откройте файл index.html.
- Введите в файл следующую разметку. Это базовая структура HTML веб-страницы. Обратите внимание, что вы будете персонализировать выделенный текст, содержащийся в тегах заголовков.
Вам может быть легче читать, если вы добавите дополнительные пустые строки, как показано в примере выше. Кроме того, отступ содержимого, находящегося внутри другого содержимого, помогает увидеть взаимосвязь между всеми частями страницы. Это стандартная практика для всех языков разметки, сценариев и программирования.
Помните: лишние пробелы и пустые строки будут игнорироваться при отображении HTML в браузере.
Давайте теперь рассмотрим каждый из этих тегов:
Комментарии в вашем коде
Приведенный и описанный на этой странице пример HTML-кода включает HTML-разметку для добавления комментариев:
Все компьютерные языки разметки или программирования предоставляют способ добавления комментариев к вашему коду. Сюда входят все три языка, изучаемые в этом курсе: HTML, каскадные таблицы стилей (CSS) и JavaScript. Фактический метод отличается в зависимости от языка, но идея всегда одна и та же. Комментарии — это примечания для вас или других, кто просматривает ваш исходный код, которые помогают сделать код более понятным. Веб-браузер просто игнорирует их, поэтому они фактически не отображаются для пользователей. Добавляйте комментарии свободно! Лучше слишком много комментариев, чем слишком мало. Вот две основные цели добавления комментариев в код:
Читайте также: