在Jupyter笔记本中插入注释

11
我希望这不是一个重复的问题,但我没有找到合适的答案和教程。我正在学习数据科学,因此使用kaggle竞赛进行实践,并使用jupyter笔记本解决它们(因为对我来说视觉上更有吸引力)。现在我偶然发现一个示例内核(见:http://nbviewer.jupyter.org/github/agconti/kaggle-titanic/blob/master/Titanic.ipynb#Data-Handling)使用注释、链接和插图介绍代码,以提供更多背景信息。
请问有人知道如何在jupyter中编写这样的注释和备注吗?如果知道,是否有在线资源可以学习这方面的知识?
非常感谢!

2
“Comments”是Markdown格式的,您可以在单元格之间切换。只需将单元格设置为“Markdown”。 - Scratch'N'Purr
确实是一个多余的问题,哈哈。非常感谢您的帮助,非常感激。 - calicationoflife
2
此外,您可能会对将Markdown生成为代码输出感兴趣:https://dev59.com/RloV5IYBdhLWcg3wauKP - Georgy
5个回答

9

是的 - 高亮一个单元格,然后点击"单元格"下拉菜单,选择"单元格类型",选择"Markdown"。然后您可以输入任何markdown文本,它将呈现为这样。

^^ 还有快捷键可以更改单元格类型。高亮一个单元格,按esc键进入"命令"模式,然后按m。这将把它更改为一个Markdown单元格。按y将其更改回代码单元格。

您还可以使用美元符号($)进行latex方程。这里有相关文档here


8

对于 Markdown 单元格

[//]: # "Your comment in here."

允许在Jupyter Notebook服务器版本6.0.1中包含注释。有关Markdown注释的更多详细信息,请参见此讨论


1
引号很重要(它们可以用括号(Comment)代替)。[//]: # Your comment in here无效。 - Abby

4

同意@RSHAP的观点。在下面我只添加了流程图。
选择活动单元格 > 单元格类型 > Markdown. 在此输入图片描述


1

无论使用哪个版本的Jupyter Notebook,以下命令都应该在当前单元格上起作用

  1. 按ESC键
  2. 然后按m键

0

如上所述,请使用 markdown 单元格。 一旦进入 markdown 单元格,使用 ########## 表示不同字体的标题。要使用粗体,请使用 **你的文本**,要使用斜体,请使用 *你的文本*。要编写方程和使用 LaTeX 命令,请使用 $ 符号。一切都像在 LaTeX 中一样运作;你甚至可以定义自己的符号,就像在 LaTeX 中通常做的那样。有关在 Jupyter 中格式化文本的更详细和结构化的概述,请参阅此网站:

https://www.earthdatascience.org/courses/intro-to-earth-data-science/file-formats/use-text-files/format-text-with-markdown-jupyter-notebook/


1
好的,我会添加更多细节。我对在Stack Overflow上做出贡献还有点新。感谢您的评论,我会添加更多背景和细节。 :) - Gaurav Saxena

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接