跳至主内容

迈向更完善的文档

· 1 分钟阅读
Kevin Lacker
Kevin Lacker
Facebook 工程经理
非官方测试版翻译

本页面由 PageTurner AI 翻译（测试版）。未经项目官方认可。 发现错误？ 报告问题 →

卓越的开发者体验离不开卓越的文档支持。编写优质文档需要付出诸多努力——理想的文档应具备简洁性、实用性、准确性、完整性和愉悦性。近期我们根据您的反馈持续优化文档，现与您分享部分改进成果。

内联示例​

当您学习新库、新编程语言或新框架时，总会有个美妙瞬间：初次编写代码片段，尝试运行，观察结果...然后它_真的_运行成功了！您亲手创造了实际成果。我们致力于将这种沉浸式体验融入文档中，例如：

import React, { Component } from 'react';
import { AppRegistry, Text, View } from 'react-native';

class ScratchPad extends Component {
  render() {
    return (
      <View style={{flex: 1}}>
        <Text style={{fontSize: 30, flex: 1, textAlign: 'center'}}>
          Isn't this cool?
        </Text>
        <Text style={{fontSize: 100, flex: 1, textAlign: 'center'}}>
          👍
        </Text>
      </View>
    );
  }
}

AppRegistry.registerComponent('ScratchPad', () => ScratchPad);

我们相信这些内联示例（借助 Devin Abbott 开发的 react-native-web-player 模块）是学习 React Native 基础的最佳途径。为此我们更新了面向新手的 React Native 教程，尽可能采用此类示例。欢迎体验——如果您曾好奇修改示例代码会产生什么变化，这将是绝佳的探索方式。此外，若您正在开发工具并希望在自有站点展示实时 React Native 示例，react-native-web-player 能让此过程变得简单直接。

核心模拟引擎由 Nicolas Gallagher 的 react-native-web 项目提供，该项目支持在 Web 端展示 Text 和 View 等 React Native 组件。如果您希望构建共享大量代码的移动端与 Web 端应用，请关注 react-native-web。

优化指南​

React Native 某些功能存在多种实现方式，我们收到反馈建议需要更明确的指导。

全新推出的导航指南对比了不同方案（Navigator、NavigatorIOS、NavigationExperimental）并提供选用建议。中期规划中我们将改进并整合这些接口，短期目标则是通过优化指南减轻您的决策负担。

我们还新增了触摸事件处理指南，讲解创建类按钮界面的基础知识，并简要归纳了处理触摸事件的不同方式。

另一优化重点是 Flexbox 布局，包含使用 Flexbox 处理布局和控制组件尺寸的教程，以及虽不炫酷但极具实用价值的React Native 布局控制属性全集。

入门指引​

在本地搭建 React Native 开发环境时，您需要完成大量安装配置工作。虽然难以将安装过程变得趣味十足，但我们至少能使其尽可能快速无痛。

我们构建了新版入门流程，支持预先选择开发操作系统与移动操作系统，将所有设置说明整合至统一界面。我们完整走查安装流程以确保各环节可靠运行，并为每个决策点提供明确建议。经过同事实测验证，我们确信这是项显著改进。

我们还在将 React Native 集成到现有应用的指南上做了改进。许多使用 React Native 的大型应用（包括 Facebook 应用自身）实际上都是部分采用 React Native 构建，部分使用常规开发工具完成的。我们希望这份指南能让更多人轻松采用这种开发模式。

我们需要您的帮助​

您的反馈决定了我们的工作优先级。我知道有人读完这篇博文会想："文档改进？切！X 功能的文档还是那么烂！"——这种态度很棒，我们需要这种能量。根据反馈类型的不同，最佳提交方式也有所区别：

如果发现文档中的具体错误（如描述不准确或代码无法运行），请提交 issue。务必添加"Documentation"标签，方便我们快速分配给对应负责人。

如果没有具体错误，但某些文档内容存在根本性困惑，则不适合提交 GitHub issue。请到 Canny 平台说明需要改进的文档区域。这能帮助我们在编写指南等系统性工作时合理规划优先级。

感谢您阅读至此，也感谢您使用 React Native！