需要github上的格式帮助吗

我是编程新手，开始将我的一些项目放到github中，这样我就可以向雇主展示一些东西。我从去年夏天做的第一个项目中复制并粘贴了代码，但是当查看页面（）时，我的代码中的所有注释部分（#symbol，因为这是在我的类中使用Python编写的）都有大量的文字。我猜github中的usign#是用于标题而不是评论，所以我有点不明白应该如何将我的程序放入github中，以便以网站标准的任何方式对其进行格式化。提前感谢你的帮助

任何名为README.md的文件都将被解释为github（以及许多其他源代码查看器）中的文件。重命名该文件以具有python扩展名（并可能创建一个带有解释的新README.md文件），这样就可以解决问题。

该文件采用标记语言。有关示例，请参见：

在您的例子中，在代码的开头和结尾使用三个反勾号（包括注释）

因此：

---

所以我现在把它写成了american_football_cosc1336/README.md，应该用什么来代替README.md？任何文件名，真的。它看起来像一个python脚本，python文件以.py结尾，因此

code.py

或

my_project.py

或

任何真正的.py都应该可以工作：我要补充的是，你完全可以把代码放在降价文件中，就像Araldo的回复显示的那样。所以，如果你真的想要一个包含代码的Read-me类型的文件，那就是最好的选择。但是代码本身不应该保存为降价。你应该发布它
```
# comment
some code
```