欢迎使用开发者门户文档指南！以下是一些关于编写和发布文档的指导原则。

语言风格

  • 如果您访问的是 /zh/xxx，则会看到中文内容。
  • 如果访问的是 /en/xxx，则会看到英文内容。

文档编写规范

  1. 清晰简洁：确保文档语言简洁明了，避免使用过于专业的术语，除非是必要的技术性说明。
  2. 逻辑结构：文档应具有良好的逻辑结构，便于读者理解和查找信息。
  3. 示例代码：提供具体的示例代码，帮助开发者更好地理解和使用功能。

图片使用

在文档中适当添加图片可以增强内容的可读性和吸引力。以下是一些使用图片的规则：

  • 图片应与内容相关，并有助于解释说明。
  • 图片应清晰美观，分辨率适中。
  • 图片大小应适当，避免影响页面加载速度。

代码示例

def hello_world():
    print("Hello, World!")

if __name__ == "__main__":
    hello_world()

扩展阅读

如果您想了解更多关于开发者门户的信息，请访问开发者门户首页。

Python 示例代码