{"meta":{"title":"Поиск и понимание примера кода","intro":"Улучшайте навыки программирования, обучая пример кода на GitHub.","product":"Начало работы","breadcrumbs":[{"href":"/ru/get-started","title":"Начало работы"},{"href":"/ru/get-started/learning-to-code","title":"Узнайте, как кодировать"},{"href":"/ru/get-started/learning-to-code/finding-and-understanding-example-code","title":"Поиск примера кода"}],"documentType":"article"},"body":"# Поиск и понимание примера кода\n\nУлучшайте навыки программирования, обучая пример кода на GitHub.\n\n## Как узнать из кода на GitHub?\n\nОбучение проектов на GitHub — отличный способ **обучения новых методов и **поиска вдохновения** для собственных проектов**.\n\nОднако с миллионами общедоступных репозиториев на GitHub, поиск кода, применяемого к проекту, может быть подавляющим. Даже после поиска идеального репозитория может быть трудно перейти к базе кода, чтобы найти полезные примеры.\n\nВместо того чтобы понять весь проект, лучше выбрать одну функцию или функцию и узнать, как она работает. Мы можем использовать функции поиска Copilot Chat и GitHub, чтобы найти функцию и следовать за ней через базу кода. Это отличный способ узнать, как мы можем увидеть, как функция работает весь путь от серверной части к интерфейсу.\n\nВ этом руководстве вы узнаете, как это сделать **, выполнив пример сценария**: узнайте, как загружать и отображать данные из файлов на веб-сайте Jekyll. Затем вы можете применить советы и методы к другим проектам и языкам программирования.\n\n## Поиск примера проекта\n\nПервым шагом является поиск подходящего проекта для обучения.\n\n### Используйте Copilot Chat для идентификации репозитория\n\nСамый быстрый способ найти проект с кодом, который можно узнать, заключается в том, чтобы попросить [Copilot Chat](https://github.com/copilot) найти репозитории, соответствующие вашим критериям.\n\nОткройте [Copilot Chat](https://github.com/copilot) и запустите чат общего назначения. Затем спросите:\n\n> Можно ли найти некоторые популярные репозитории, использующие Jekyll для отображения данных из файлов в репозитории?\n\nCopilot вернет ссылки на соответствующие репозитории, и вы можете задать дополнительные вопросы о репозиториях.\n\nЧасто Copilot завершает ответ с ссылкой на GitHub с дополнительными результатами. Далее мы рассмотрим эти результаты.\n\n### Использование поиска для определения дополнительных параметров\n\nЕсли Copilot включили ссылку на результаты поиска, следуйте ссылке. Если нет, создайте собственный поисковый запрос, выполнив приведенные ниже действия.\n\n1. Перейдите к расширенному поиску[](https://github.com/search/advanced).\n2. В разделе \"Дополнительные параметры\" используйте раскрывающийся список \"Написанный на этом языке\" для выбора языка программирования. Для нашего сайта Jekyll мы будем выбирать HTML.\n3. При необходимости в разделе \"Параметры репозиториев\" рядом с параметром \"С этим множеством звезд\", введите `>150`. Это поможет вам найти популярные репозитории, которые, вероятно, хорошо поддерживаются.\n4. В верхней части страницы нажмите кнопку **\"Поиск**\".\n\n> \\[!TIP]\n> Мы можем дополнительно сузить результаты поиска, добавив разделы и текст в поисковый запрос. Например, `topic:jekyll \"blog\"` возвращать репозитории владелец классифицировался как связанный с Jekyll и словом \"блог\" в имени или описании репозитория. Список популярных тем см. в разделах [GitHub](https://github.com/topics).\n\n### Выбор проекта\n\nПосле просмотра результатов из Copilot и поиска мы решили использовать репозиторий [`github/choosealicense.com`](https://github.com/github/choosealicense.com) . Этот репозиторий содержит исходный код [Choose a License](https://choosealicense.com/) — сайта Jekyll, который делится информацией о open source лицензиях.\n\nНас особенно интересует страница [Licenses](https://choosealicense.com/licenses/), где представлены популярные лицензии open source из файлов данных. \n\n## Ориентирование на себя в проекте\n\nПрежде чем искать код для отображения файлов данных, давайте настроимся в репозитории в целом.\n\nТрудно узнать, где начать при первом посещении репозитория. Хотя каждый проект будет упорядочивать себя по отдельности, существуют распространенные методы документации, которые мы обычно можем полагаться на получение наших данных.\n\n### Файл README.md\n\nВсегда рекомендуется читать **файл README.md** , который является первой страницей репозитория и автоматически отображается под списком файлов. Различные средства обслуживания будут включать разные сведения, но часто можно найти сведения о проекте, как создать его на локальном компьютере и ссылки на документацию.\n\n[\n`github/choosealicense.com`\n](https://github.com/github/choosealicense.com) В репозитории README.md-файл объясняет, где живут файлы лицензий (`/_licenses`), атрибуты каждой лицензии и как получить веб-сайт, работающий на компьютере.\n\n### Использование Copilot Chat\n\nЕсли файл README.md не дает вам всех ответов, вы можете попросить Copilot помочь вам перейти к репозиторию и найти функциональные возможности.\n\nЧтобы открыть переменные данных.copilot. copilot\\_chat\\_short %} нажмите на значок **** рядом с строкой поиска и задайте свой вопрос. Например:\n\n> Что такое основная целевая страница для этого веб-сайта Jekyll?\n\nПри запросе Copilot вопросов о репозитории он может возвращать соответствующие файлы, объяснить часть, с помощью которых они играют в функциональных возможностях, и включить ссылки.\n\n### Вики-сайт репозитория\n\nДругой возможный источник информации — вики-сайт\\*\\* репозитория\\*\\*, раздел репозитория специально для размещения документации. Каждый репозиторий на GitHub оснащен возможностью использовать вики-сайт, но не каждый репозиторий использует его. Чтобы получить доступ к вики-сайту, щелкните вкладку ** Wiki** в репозитории.\n\n### Выпуски\n\nЕсли исходный код репозитория встраивается в исполняемый файл, некоторые ответственный за репозиторий будут использовать выпуски\\*\\* репозитория \\*\\*для публикации двоичных файлов. Вы можете скачать и запустить эти двоичные файлы, чтобы изучить, как работает приложение при изучении базы кода, не создавая проект самостоятельно.\n\nВыпуски репозитория можно найти на боковой панели справа от списка файлов и README.md.\n\n### Внутренняя документация\n\nВы также можете найти внутреннюю документацию в содержимом репозитория. Это может быть один файл Markdown или каталог, полный файлов Markdown. Распространенные имена для поиска: \"docs\", \"документация\", \"wiki\", \"resources\", \"help\" и \"manual\".\n\n## Навигация по исходному коду\n\nТеперь, когда мы понимаем общую структуру репозитория, пришло время использовать поиск GitHub для поиска конкретных функциональных возможностей, которые мы ищем.\n\nКогда вы находитесь в репозитории и щелкните поле поиска в верхней части страницы, GitHub автоматически добавит `repo` квалификатор поиска, чтобы результаты поиска были ограничены в репозитории, который вы просматриваете.\n\nЧтобы приступить к работе, нам нужно что-то найти. Это может быть строка текста, уникального для проверяемой функции, или мы могли бы просмотреть html-источник страницы и найти конкретный `class` или `id` атрибут.\n\nВ нашем примере мы найдем текст в верхней части [страницы](https://choosealicense.com/licenses/) лицензий, используя следующий запрос: [`repo:github/choosealicense \"If you’re looking for a reference table?\"`](https://github.com/search?q=repo%3Agithub%2Fchoosealicense.com+%22If+you%E2%80%99re+looking+for+a+reference+table%22\\&type=code) Возвращается один результат, файл с именем `licenses.html`.\n\nТеперь мы можем щелкнуть результат и углубиться!\n[\n`licenses.html`\n](https://github.com/github/choosealicense.com/blob/gh-pages/licenses.html) является источником страницы \"Лицензии\" мы искали. Мы видим строку, которую мы искали, и что каждая из лицензий включена в код ниже:\n\n```markdown\n{% include license-overview.html license-id=\"agpl-3.0\" %}\n```\n\n## Общие сведения о исходном коде\n\nТеперь, когда мы нашли конкретный код, который мы заинтересованы, мы можем перейти к его пониманию.\n\n### Запрос Copilot Chat о коде\n\nВы можете использовать Copilot для получения дополнительных сведений о файле или даже определенных строках кода. Copilot объединяет сведения о языке программирования с контекстом из репозитория, чтобы получить подробные ответы на ваши вопросы.\n\nДавайте попросите Copilot объяснить, что происходит в строке 11 с тегом `{% include %}` . Щелкните номер строки. Затем справа от строки нажмите . В окне чата попросите:\n\n> Что происходит в этой строке?\n\nCopilot объяснит, что строка включает `license-overview.html` файл и передает их в `\"agpl-3.0\"` качестве отображаемого `license-id` .\n\n> \\[!TIP]\n> Если вы не понимаете ответ от Copilot Chat, вы всегда можете попросить его упростить или расширить в определенной части.\n\n### Чтение комментариев\n\nКомментарии — это доступные для чтения заметки, которые можно использовать для понимания кода и не выполняются. Обычно они разделены символами, такими как `//` или `/*`.\n\nЕсть несколько типов комментариев для поиска:\n\n* **Строка**: одно строковый комментарий, описывающие то, что делает определенная строка\n* **Блок**: много строковый комментарий, которые могут описать, что делает вся функция или файл.\n* **Файл**: блок-комментарий в самом начале файла, предоставляющий обзор этой конкретной части базы кода.\n\n### Поиск функций в ссылках на язык программирования\n\nКаждый язык программирования будет иметь ссылку в Интернете, объясняя каждый аспект языка.\n\nПри использовании поисковой системы для поиска языка программирования и функции необходимо найти ссылку на эталонную страницу этой функции.\n\nВ нашем примере поиск `jekyll include` в поисковой системе должен вернуть [документацию \"Включает\" в документации](https://jekyllrb.com/docs/includes/) Jekyll. Если ознакомиться с документацией Jekyll, мы видим, что сами лицензии являются коллекцией в каталоге[](https://jekyllrb.com/docs/collections/)`_licenses`.[](https://github.com/github/choosealicense.com/tree/gh-pages/_licenses)\n\n> \\[!TIP] Если вы не можете найти функцию в справочнике по языку программирования, скорее всего, эта функция определена в самой базе кода. Попросите [GitHub Copilot](https://github.com/copilot) найти его.\n\nЧтобы сводные сведения о том, что мы узнали: [`licenses.html`](https://github.com/github/choosealicense.com/blob/gh-pages/licenses.html) файл включает в себя [`/_includes/license-overview.html`](https://github.com/github/choosealicense.com/blob/gh-pages/_includes/license-overview.html) каждую лицензию. Файл [`/_includes/license-overview.html`](https://github.com/github/choosealicense.com/blob/gh-pages/_includes/license-overview.html) соответствует `license-id` предоставленной лицензии в [`/_licenses`](https://github.com/github/choosealicense.com/tree/gh-pages/_licenses) коллекции и отображает сведения.\n\n### Экспериментирование с небольшими изменениями\n\nЕсли вы можете локально запустить проект на компьютере, отличный способ узнать, чтобы внести небольшие изменения, чтобы увидеть, что происходит.\n\nВы можете начать с изменения текста, а затем перейти к внесению больших изменений, таких как экспериментирование с тем, как функции и файлы взаимодействуют друг с другом.\n\nПопробуйте найти [`license-overview.html`](https://github.com/github/choosealicense.com/blob/gh-pages/_includes/license-overview.html) файл в `_includes` каталоге, а затем внести изменения в способ отображения лицензии или экспериментировать с тем, как лицензия загружается из коллекции.\n\nВы можете изменить метаданные в начале одного из файлов лицензий, изменить атрибуты, отображаемые в `license-overview.html`, или даже попробовать добавить собственный атрибут. После внесения изменений его можно протестировать, выполнив README.md инструкции по просмотру в браузере.\n\n### Применение того, что мы узнали\n\nРепозиторий [`github/choosealicense.com`](https://github.com/github/choosealicense.com) является отличным примером большого проекта Jekyll и демонстрирует, сколько возможно с Jekyll и GitHub Pages. Можете ли вы применить то, что вы узнали из структуры репозитория, как он использует коллекции и как он включает данные лицензии для создания собственного проекта?\n\n## Следующие шаги\n\nТеперь, когда вы понимаете, как работает пример кода, может потребоваться повторно использовать его в собственном проекте. Повторное использование кода является мощной частью разработки программного обеспечения, но есть важные шаги, чтобы сделать это правильно и юридически. Полный учебник см. в разделе [Повторное использовать код других пользователей в проектах](/ru/get-started/learning-to-code/reusing-other-peoples-code-in-your-projects)."}