Вопросы-опросники запрещены на Stack Overflow на русском. Для получения ответа, перефразируйте ваш вопрос так, чтобы на него можно было дать однозначно правильный ответ.
Закрыт 8 лет назад .
Как оформляется исходный код в пояснительной записке, есть ли какие-то стандарты?
Отслеживать
30.9k 13 13 золотых знаков 96 96 серебряных знаков 155 155 бронзовых знаков
задан 31 мая 2015 в 5:51
75 1 1 серебряный знак 6 6 бронзовых знаков
Я голосую за закрытие этого вопроса как не соответствующего теме, потому что правила оформления документов здесь не обсуждаются.
31 мая 2015 в 5:55
31 мая 2015 в 11:54
31 мая 2015 в 12:03
Всем спасибо,вопрос снят, можно закрывать тему.
31 мая 2015 в 14:44
1 ответ 1
Сортировка: Сброс на вариант по умолчанию
Собственно ответы на такие вопросы надо узнавать непосредственно у того, кто будет принимать работу. У всех преподавателей требования разные, разные и убеждения.
Нет какого-то четкого правила, кто-то использует табуляцию, кто-то пробелы, кто-то в 4 символа, а кто то в 2. Лично я использую пробел, 2 символа отступ. Т.е. табуляция везде в настройках разная, а пробел почти везде выглядит одинаково.
Как оформить дипломную работу по ГОСТУ 2020 за 3 минуты
Источник: ru.stackoverflow.com
Правила размещения в тексте научных работ листинга программ для ЭВМ
При подготовке научной работы в IT-области (особенно по направлению «Программирование», «Тестирование ПО» и пр.) важно не просто предоставить «готовый» инновационный продукт, но и описать его в основной части проекта. Для полноценной характеристики разработки необходимо предоставить подробное разъяснение каждого элемента. Делается это с помощью листинга.
При подготовке научной работы в IT-области (особенно по направлению «Программирование», «Тестирование ПО» и пр.) важно не просто предоставить «готовый» инновационный продукт, но и описать его в основной части проекта. Для полноценной характеристики разработки необходимо предоставить подробное разъяснение каждого элемента. Делается это с помощью листинга.
Понятие и функции листинга программ для ЭМВ в студенческих и научных работах
Листинг программ для ЭВМ представляет собой оригинальный и порой весьма запутанный вид информации, который будет абсолютно непонятен для обычного читателя, не владеющего азами программирования. Это специфический код программы или приложения, на основе которого запускается определенный процесс, работа устройства и пр. То есть он представляет собой зашифрованное послание, призванное переработать человеческий язык на машинный и запустить соответствующие процессы в устройстве.
Как оформить приложения в Дипломной работе по ГОСТУ? Простой разбор с примерами.
Внешне листинг программ представлен в виде набора специальных символов и цифр, каждое из которых имеет определенное значение и предназначение.
Основная задача листинга – сохранить последовательность команд и итераций на закодированном языке, помочь разработчикам и изобретателям разобраться в специфике определенных устройств, приложений и программ.
Листинг может быть представлен в развернутом и сокращенном виде. Первый представляет собой полное закодированное описание, своего рода полномасштабный алгоритм программы. Его объем может достигать сотни страниц. У каждого символа и значения имеется своя роль и цель, «перевод» на русский язык в виде определенной команды.
Сокращенный вариант чаще всего предполагает точечный обзор программы. Для его формирования необходимо выделить наиболее значимые моменты и элементы из всей цепи кодов.
Среди существенных функций листинга программ для ЭВМ при выполнении студенческих и научных работ можно выделить следующие. Во-первых, информационный характер или описательная функция. Конечно, далеко не каждый простой читатель сможет разобраться в подобных шифрах, но даже начинающий программист или IT-специалист сумеет понять последовательность процессов и специфику языка программирования, особенности задействованного инструментария и методологии и пр.
Во-вторых, констатационная или правоустанавливающая. Предоставление листинга позволяет зафиксировать факт разработки и закрепить за собой авторские права на описанный механизм, алгоритм. Данный формат обязателен для регистрации патента и точно не будет лишним на защите кандидатской или докторской диссертации.
В-третьих, доказательная. С помощью листинга можно оценить не только состав и качество программы, но и выделить е специфические черты: новшества, привнесенные автором, особенности работы и эффект от реформирования цепи или отдельных звеньев алгоритма, проверить соблюдение действующих правил и законов, ГОСТов и пр. Именно листинг подчеркивает оригинальность проекта и разработки, помогает отстоять выдвинутую гипотезу или показать ценность реформирования, пользу полученных результатов, выделить достоинства и недостатки новшеств. Именно данная часть студенческой или научной работы считается первичным материалом и основой доказательной базы исследования.
Таким образом, листинг программ для ЭВМ представляет собой набор символов и шифров, на основе которых работает специальная (ранее действовавшая или новоиспеченная) программа. Для студенческой или научной работы листинг выполняет констатационную и доказательную роль, подчеркивая самостоятельность автора и оригинальность изыскания.
Как сформировать листинг программ для ЭВМ?
В зависимости от целей подготовки листинга программ ЭВМ можно выделить два основных формата листинга: полномасштабный и сокращенный.
Полный листинг представляет собой полное представление шифра и кодов, на основе которых строится действие программы. То есть внешне это будет набор символов, букв, цифр в конкретной последовательности. Для его подготовки важно владеть языками программирования, понимать правила кодирования данных, уметь оперировать ими и преобразовывать, дополнять или оптимизировать существующие алгоритмы, цепи и связи.
Полный листинг предстает в виде объемного зашифрованного описания программы или приложения. Для его подготовки важно выделить тему и идею научной работы, авторские записи или иметь под рукой готовый вариант программы. Можно вручную написать все коды и символы или сделать скриншоты рабочей версии программы в закодированном виде.
То есть полный листинг должен содержать все символы, коды, обозначения и цепи программы. Это естественный или первозданный вид ПО или приложения, на основе которого оно функционирует.
Полный листинг требуется для регистрации авторских прав и патентов на изобретение или инновационную часть (непосредственно разработку), а также может быть приложен к научной работе.
Для подготовки сокращенного листинга программ ЭВМ необходимо тщательно проанализировать и переработать полный алгоритм программы, чтобы выделить из всего списка символов самые важные моменты. Чаще всего к таким фрагментам, достойным вынесения в констатационно-описательный документ относят следующие элементы:
- Основные коды, базовая часть алгоритма: ключевые команды-действия, массивы и пр.;
- Инновационная часть, которая подчеркивает разработку автора, инновацию, внесенную им. Она представлена в виде соответствующего шифра, кода или группы символов и цифр, букв;
- Основные переходы и связки между традиционными и новыми подходами, кодами и пр.
Точечный листинг призван выделить инновации и вклад автора, подчеркнуть сильные и слабые зоны программы, обосновать авторскую позицию и гипотезу, показать эффективность конечных результатов исследования и разработки в целом.
Формирование сокращенного листинга программ для ЭВМ призвано предоставить точечную характеристику проекта с акцентом на сильные стороны автора, выделить достоинства изысканий и ценность результатов.
Подготовка неполного листинга требует тщательного анализа полного кода программы (алгоритма): производится тщательная выборка основополагающих и инновационных элементов. Важно выделить полноценные блоки из полной схемы.
В точечный листинг выносят самостоятельные звенья, которые имеют свое начало и конец и выполняют определенную операцию, команду.
Нужна помощь преподавателя?
Как программисту написать диплом. Полное руководство
Всем привет, меня зовут Александр и в этом году я заканчиваю магистратуру.
Так получилось, что сейчас я пишу 2 диплома или, правильнее сказать, 2 магистерских диссертации одновременно: одну на русском языке по российским стандартам, а вторую — на английском языке по немецким стандартам. Почему так получилось, я расскажу как нибудь потом (совсем другая история), а сейчас, я бы хотел поделиться своими знаниями в области написания работ бакалавров и магистерских диссертаций в преддверии летних защит.
Введение. Фундамент работы
Как и в твоём дипломе, в моей статье тоже должно быть введение. О структуре поговорим позже, а сейчас, хотел бы сказать с чего всё начинается.
А начинается всё с того, что тебе необходимо что-то сделать, например, если ты бакалавр, то твоя работа должна быть более проектной (70% Техническая часть 30% Исследовательская часть). Обычно, работы бакалавров в Computer Science заключаются в создании какого либо приложения, которое автоматизирует определенную задачу, например «Автоматизированная система библиотеки».
Работы магистров формально и фактически должны состоять в большей степени из исследовательской части и в меньшей из технической (70/30). Но зачастую, программисты делают магистерские работы аналогичными бакалаврским, только в более расширенном варианте и пытаются притянуть за уши какую-никакую «науку» в них.
Если хочешь написать хороший диплом, задумайся об этом за 1 год, а ещё лучше за 2. Если ты бакалавр, то можешь начать спрашивать на кафедре про проекты, в которых ты бы мог принять участие. Если кафедра разрешает писать дипломы по своим собственным проектам — тоже хорошо. Если ты магистр, то самым простым вариантом будет продолжать делать то, что ты уже делал в бакалавриате, пытайся изобрести что-нибудь новое или же использовать что-то существующее в новой задаче. Публикация статей и поездки на конференции формируют бэкграунд для того, чтобы успешно написать свою работу и суметь её защитить.
Личный пример: Тема моего бакалаврского диплома находится на стыке Computer Science и Natural Language Processing (NLP) и называлась так: «Разработка диалоговой системы для помощи студентам и абитуриентам ВУЗа». Этакий ВУЗовский чатбот. В данной работе большее внимание я уделял написанию веб-приложения и меньше рассматривал отдельные методы из NLP, которые я использовал в своём чатботе.
В магистерской диссертации наоборот, я большее внимание уделяю конкретным методам и подзадачам. Изучаю влияние входных данных на качество выхода и так далее. Разработке приложения уделяется минимальное внимание, в этом и разница.
Итак, что же нужно делать? Если ты бакалавр — пиши приложение, если магистр — делай исследование. В обоих случаях старайся ездить на конференции и публиковать статьи — это поможет заложить крепкий фундамент выпускной квалификационной работы.
Когда это нужно делать? Начинать нужно за 1-2 года до срока сдачи диплома, а заканчивать стоит за 1-2 месяца до сдачи. Это время тебе понадобится на написание отчёта, о котором поговорим далее.
Зачем это нужно делать? В первую очередь для себя. Если ты сможешь написать простенькое CRUD приложение, то у тебя есть все шансы пойти работать Junior разработчиком в локальную ИТ-конторку. А ещё, тебе нужно выпуститься из ВУЗа, так что код писать в любом случае придётся.
Написание отчёта
Обычно, под дипломом студенты понимают именно отчёт, особенно такое мнение популярно в России. Более того, я знаю человека, который часть своего диплома написал с помощью генератора текста (о котором и был его диплом). К сожалению, такой подход, по моему мнению, ошибочен, ведь отчёт — это всего лишь описание того, что ты сделал. А о том, что нужно делать мы уже поговорили в предыдущей части.
Перед тем, как писать отчёт — тебе необходимо почитать научные статьи по твоей тематике, желательно те, которые ты потом сможешь использовать в списке литературы своей работы. Выбери 15-20 статей (50% русских, 50% зарубежных) и начни штудировать. Искать статьи можно тут: E Library и Google Scholar.
Так же полезно иметь парочку полноценных книг по твоей теме, из них можно брать фундаментальные понятия, например про принципы ООП. Искать книги можно тут: Вконтакте Документы OZON. Можешь не читать всё целиком, а лишь бегло и осознанно пробежаться по основным пунктам, впоследствии, для уточнения деталей ты ещё не раз будешь возвращаться к той или иной статье.
После того, как ты ознакомился с литературой, можешь начинать накидывать «скелет» твоего диплома. Где это делать — решать тебе, обычно все пишут в Ворде, можно делать в Гугл Доке, а если ты преисполненный и умеешь пользоваться LaTeX, то ищи соответствующий шаблон и пиши там! Примерная структура диплома программиста в соответствие с ГОСТом 7.32 выглядит следующим образом:
- Титульный лист (зависит от вашего ВУЗа)
- Реферат (пишется по госту, примерная длина — одна страница)
- Определения (прописываем все определения, например «Инкапсуляция — . ». Всё в алфавитном порядке)
- Обозначения и сокращения (прописываем в алфавитном порядке все аббревиатуры)
- Введение (описание важности проблемы, статистика, описание самой проблемы, цель и задачи)
- 1. Теоретические и технические основы (описывает основные понятия и технологии, которые вы используете)
- 2. Описание предложенного подхода (для бакалавров — проектирование программного продукта со всеми вытекающими, для магистров постановка и описание экспериментов, описание предлагаемых методов решения задачи)
- 3. Имплементация (для бакалавров — описание процесса разработки, для магистров — описание процесса проведения экспериментов, анализ результатов и выведенные инсайды).
- Заключение (подведение итогов, обзор выполненных задач и цели, ограничения работы и последующая работа)
- Список использованных источников (в порядке цитирования, можно юзать сервис snoska.info)
- Приложения (может быть листинг кода, модели данных и т.д.)
Ещё, к данной структуре диплома могут быть добавлены две главы: Экономическое обоснование и Защита информации. Всё зависит от требований вашей кафедры или университета.
По поводу оформления — я бы не хотел вдаваться в подробности в этой статье, требования достаточно полно описаны в ГОСТе 7.32.
Когда это нужно делать? Начинай писать отчёт за 2-3 месяца до сдачи диплома.
Зачем это нужно делать? Это формальность, которая позволит тебе выпуститься из ВУЗа. Есть и приятный бонус: написание отчёта помогает тебе структурировать в голове все знания, полученные в процессе работы.
Подготовка презентации
Окей, ты проделал большую работу и написал отчёт, осталось это красиво презентовать. Начинай готовить слайды, когда отчёт уже почти завершен. Структура презентации должна примерно соответствовать структуре твоего отчёта, а оформление слайдов индивидуально для каждого ВУЗа или кафедры.
Чего НЕ нужно делать:
- Вставлять код на слайды
- Вставлять длинные схемы алгоритмов на слайды
- Писать длинные определения
- Заполнять слайд текстом на 100%
Личный пример: я всегда структурирую слайды для презентации по тому же принципу, как и в отчёте. Готовлю слайды в зависимости от требований по оформлению, если сторих рамок нет, то использую LaTeX, если есть строгие правила по оформлению и нет шаблона в LaTeX, то использую Power Point.
Итак, что же нужно делать? Создай структуру слайдов в соответствии с оглавлением твоего отчета и заполни их шаг за шагом. Затем, по тому же принципу напиши доклад и отрепетируй презентацию.
Когда это нужно делать? Начинай готовить презентацию за 2-3 недели до защиты.
Зачем это нужно делать? Опять же, это формальность, которая позволит тебе выпуститься из ВУЗа. А ещё, это поможет тебе научиться грамотно презентовать твоё исследование.
Заключение
Вместо заключения хотел бы пожелать всем, кто в этом году заканчивает ВУЗ — удачных защит, а тем, кто это будет делать позже — «готовьте сани летом». Если лень читать, просто пробегись по пунктам, выделенным жирным шрифтом, там я постарался собрать краткую выжимку из каждого параграфа. Жду ваши комментарии внизу!
Источник: habr.com