許多新手程序員發現Django文檔內容非常龐大。

假設想學習如何為用戶執行登錄。看著很簡單：登錄是Django的核心功能。如果搜索“ django登錄”或搜索文檔，則會看到一些選項，其中“使用Django身份驗證系統”是最有希望的結果。單擊該鏈接，很高興地期望登錄問題將很快就會搞定，但這39頁的頁面估計會被嚇一跳，信息太多了。

另外，也可以在django.contrib.auth上找到一些參考，所有auth內容都在這里，如果瀏覽此頁面，將看到所有不同身份驗證模型，字段和功能的羅列，但沒有說明它們應該如何組合在一起。

在這時，我們可能想絕望的關閉瀏覽器，搞得自己要重新考慮學習Django的決定了。看個文檔為什么這么難找到？為什么本文檔如此零散？

經驗豐富的開發人員怎么知道“正確的地方”在哪里？Django文檔中的目錄太長了。但是我們也會發現其他人對Django文檔的出色表現贊不絕口：難道我搞錯了？

如果可以在幾分鐘之內或更短的時間內從提出問題到找到答案，那不是很好嗎？作為專業的Django開發人員，每天都會不斷地掃描文檔以找出解決問題的方法。

在這篇文章中，我將概述如何在Django文檔中找到所需的內容，以減少沮喪和停留的時間，而將更多時間用于編寫Web應用程序。我還列出了一些我認為有用的關鍵參考。

經驗豐富的開發人員他們的觀點是對的：知道如何閱讀文檔對于程序員來說是一項非常重要的技能，而擅長于此將節省大量時間。

找到正確的部分
庫文檔幾乎總是用不同的部分編寫的。如果不了解這些部分的用途，那么將完全迷路。如果有時間，請觀看Daniele Procida的精彩演講，討論如何組織文檔。在演講中，他描述了文檔的四個不同部分：

教程：展示如何完成一個小項目的課程(示例)
操作方法指南：有關如何解決常見問題的步驟的指導(示例)
API參考：所有代碼的詳細技術說明(示例)
說明：設計決策的高層討論(示例)
除了這些之外，通常還有一個快速入門(示例)，這是開始使用該庫所需的絕對最低限度的步驟。

Django Rest Framework文檔使用與此類似的結構

Django文檔使用與此類似的結構

所有這些文檔都被劃分為不同的部分。一旦學習了這種結構，就可以快速瀏覽大多數文檔。既然了解了庫文檔通常是以特定的方式構造的，那么我將解釋如何瀏覽該結構。

首先做教程
這看起來似乎很明顯，但是我不得不說。如果文檔中有教程，請執行該教程。在這里，作者可能決定引入對理解其他所有內容至關重要的概念，至少要略讀一下。

查找示例，指南或概述
除非已經確切知道要查找的內容，否則請避免使用API參考部分。因為標題中包含“參考”，并且內容非常詳細，沒有一些高級解釋。例如，django.contrib.auth是參考部分-在這里不是學習“ Django登錄”工作原理的好地方。

在查看API參考之前，需要了解代碼的各個部分如何組合在一起。這可能很難，因為大多數文檔(甚至是非常好的文檔)都不完整。盡管如此，最好的嘗試還是尋找框架功能的概述和解釋。

查找并掃描操作指南列表，以查看它們是否能夠解決確切問題。如果該指南可以直接解決問題，則可以節省大量時間。

如果沒有指南，請快速掃描主題列表，然后嘗試查找所需的主題。如果還不太了解該主題，請閱讀概述。例如“身份驗證”和“授權”(它們是不同的，特定的內容)。

一旦認為應該理解所有內容如何融合在一起，就可以轉到詳細的API參考，從而確保正確使用代碼。

查找并記住關鍵參考
了解了要執行的操作后，將需要使用API參考頁來準確確定應編寫的代碼。最好記住包含最有用參考的關鍵頁面。這是我一直使用的個人收藏夾：

設置參考：所有設置及其作用的列表
內置模板標簽：所有帶有示例的模板標簽
Queryset API參考：使用ORM訪問數據庫的所有不同工具
模型字段參考：所有不同的模型字段
優等的基于類的視圖：Django每種基于類的視圖的詳細說明

使用Django REST Framework時，我經常會提到：

優等的DRF：類似于基于優等的視圖，但適用于DRF
序列化器參考：使序列化器工作
序列化器字段參考：所有不同的序列化器字段
嵌套關系：如何將序列化程序置于其他序列化程序內部閱讀的搜尋趨勢
大多數文檔并不是像一本小說一樣從頭到尾進行線性閱讀：大多數頁面閱讀時間太長。相反，應該策略性地搜索所需內容。大多數文檔都涉及很多內容，因為它們太多了，因此作者需要詳細解釋。我們不能依靠強力讀取所有內容來找到所需的信息。

可以使用瀏覽器的內置文本搜索功能(ctrl-f)快速找到所需的文本。這樣可以節省大量的滾動操作。瀏覽Django文檔時，我一直使用這種技術。

此外，大多數真正的長頁面都會有一個側邊欄，匯總所有內容。

閱讀源代碼
這有點像“自己動手做”的文檔，但是當需要答案而文檔沒有答案時，代碼就是該庫工作方式的權威來源。有許多庫詳細信息太費力以致無法完整記錄，有時期望如果我們真的需要了解某些功能，則應該嘗試閱讀代碼。Django源代碼編寫得相當好，投入其中的時間越多，瀏覽起來就越容易。對于初學者來說，這并不是真正的建議，但也可以嘗試一下。

總結
在我看來，Django文檔確實非常不錯，但是像大多數代碼文檔一樣，對于初學者來說，它們很難導航。我希望這些技巧將對Django的學習更加愉快。總結一下我的技巧：識別文檔的不同部分
如果沒有信心，或者至少略讀了本教程，請先做本教程
盡早避免API參考
嘗試找到如何指導問題
嘗試查找主題概述和主題說明
記住關鍵參考，以便以后快速查找
搜索文檔，不要像看書一樣閱讀它們
絕望地閱讀源代碼
Django文檔雖然沒有，在某個時候，需要轉向Django社區博客，視頻，課程和書籍。

以上就是快速閱讀django官方穩定的方法，可以在日常閱讀中使用，提供學習效率。

總結

以上是生活随笔為你收集整理的django文档_如何在django官方文档中快速找到需要的内容的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。