Нужна помощь с форматированием на github

Question

Я новичок в программировании и начинаю помещать некоторые свои проекты в github, чтобы мне было что показать работодателям. Я скопировал и вставил код из одного из моих первых проектов, которые я делал прошлым летом, но при просмотре страницы (https://github.com/allisonecrenshaw/world_cup_cosc1336) все разделы комментариев из моего кода (символ # с тех пор, как этот был написан в у моего класса, который использовал Python), есть гигантское письмо. Я предполагаю, что usign # в github предназначен для заголовков, а не комментариев, поэтому я немного растерялся из-за того, как на самом деле я должен помещать свои программы в github, чтобы он был отформатирован любым стандартным для сайта способом. Заранее спасибо за помощь.

Answer 1

Файл на языке уценки. Примеры см .: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

В вашем случае используйте три обратные галочки в начале и конце вашего кода (включая комментарии).

Итак:

```
# comment
some code
```

Answer 2

Любой файл с именем README.md будет интерпретироваться как файл Markdown в github (и многих других средствах просмотра исходного кода.) Переименуйте файл, чтобы иметь расширение python (и, возможно, создайте новый README .md файл с пояснениями) и это должно решить проблему.