跳到主要內容

邁向更完善的文件

·4 分鐘閱讀時間
Kevin Lacker
Kevin Lacker
Facebook 工程經理

擁有絕佳的開發人員體驗，一部分在於擁有優良的文件。建立良好的文件需要投入大量心力 - 理想的文件應簡潔、實用、準確、完整且令人愉悅。最近，我們根據您的意見回饋，努力改善文件，並想分享我們所做的一些改進。

嵌入式範例​

當您學習新的程式庫、新的程式語言或新的框架時，在您第一次編寫一些程式碼、嘗試執行、看看是否有效時，總會有個美好的時刻... 而且它確實有效。您創造了真實的東西。我們希望將這種發自內心的體驗直接放入我們的文件中。就像這樣

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);

我們認為這些嵌入式範例，透過使用 react-native-web-player 模組並在 Devin Abbott 的協助下，是學習 React Native 基礎知識的好方法，並且我們已更新 適用於 React Native 新開發人員的教學課程，盡可能使用這些範例。請查看一下 - 如果您曾經好奇修改一小段範例程式碼會發生什麼事，這是個非常好的探索方式。此外，如果您正在建置開發人員工具，並且想在您自己的網站上顯示即時 React Native 範例，react-native-web-player 可以讓這件事變得簡單明瞭。

核心模擬引擎由 Nicolas Gallagher 的 react-native-web 專案提供，該專案提供了一種在網頁上顯示 React Native 組件 (如 Text 和 View) 的方法。如果您有興趣建置共用大量程式碼的行動裝置和 Web 體驗，請查看 react-native-web。

更佳指南​

在 React Native 的某些部分，有多種方法可以做事，我們聽取了意見回饋，認為我們可以提供更佳的指南。

我們有新的 導航指南，比較了不同的方法，並建議您應該使用什麼 - Navigator、NavigatorIOS、NavigationExperimental。從中期來看，我們正努力改進和整合這些介面。在短期內，我們希望更佳的指南能讓您的生活更輕鬆。

我們還有新的 觸控處理指南，說明了建立類似按鈕介面的一些基本知識，以及處理觸控事件的不同方式的簡要摘要。

我們處理的另一個領域是 Flexbox。這包括關於如何使用 Flexbox 處理版面配置 以及如何控制 組件大小 的教學課程。它還包括一個不吸引人但希望有用的 React Native 中控制版面配置的所有屬性清單。

開始使用​

當您開始在您的機器上設定 React Native 開發環境時，您確實需要執行一堆安裝和設定。很難讓安裝成為真正有趣和令人興奮的體驗，但我們至少可以盡可能使其快速且輕鬆。

我們建置了 全新的開始使用工作流程，讓您可以預先選擇您的開發作業系統和行動作業系統，以提供一個簡潔的地方，其中包含所有設定指示。我們也完成了安裝過程，以確保一切正常運作，並確保每個決策點都有明確的建議。在我們的無辜同事身上測試過後，我們非常確定這是一項改進。

我們也致力於 將 React Native 整合到現有應用程式的指南。許多使用 React Native 的最大型應用程式，例如 Facebook 應用程式本身，實際上是在 React Native 中建置應用程式的一部分，並使用常規開發工具建置另一部分。我們希望本指南能讓更多人更容易以這種方式建置應用程式。

我們需要您的協助​

您的意見回饋讓我們知道我們應該優先處理什麼。我知道有些人會閱讀這篇部落格文章，然後想「更佳的文件？切！X 的文件仍然是垃圾！」。這很棒 - 我們需要這種能量。給予我們意見回饋的最佳方式取決於意見回饋的類型。

如果您在文件中發現錯誤，例如不準確的描述或實際上無法運作的程式碼，請提交問題。使用「Documentation」標記它，以便更輕鬆地將其轉發給正確的人員。

如果沒有特定的錯誤，但文件中的某些內容從根本上來說令人困惑，則不適合提交 GitHub 問題。相反地，請在 Canny 上發布關於文件中可能需要協助的區域。這有助於我們在進行更一般的工作 (如指南撰寫) 時確定優先順序。

感謝您閱讀到這裡，也感謝您使用 React Native！