前端目錄構建規范


一、前端目錄構建規范的作用

  目的是與項目開發的目錄結構保持一致,便於項目的構建與管理。

 

二、資源分類

  1、源代碼資源

    指開發者編寫的源代碼,包括html、css、template等

  2、內容資源

    指希望作為內容提供給訪問者的資源,包括圖片、字體、flash、pdf等,最常用的應該就是readme.md文件

 

三、目錄命名規則

  1、簡潔  有習慣性的縮寫單詞,采用容易理解的縮寫。如源代碼目錄src,不要寫成source

  2、常用的一些文件名稱  

    img:圖片  不要使用image、images、imgs等

    js:JavaScript腳本  不要使用script、scripts等

    css:樣式表  不要使用style、styles等

    swf:flash  不要使用flash等

    src:源文件目錄  不要使用source等

    dep:第三方依賴包  不要使用lib、library、dependency等

    注意:不允許出現復數形式,如imgs、deps是不允許的。

 

四、根目錄的划分

  根目錄下按照職能進行划分,不允許將資源類型或者業務邏輯的目錄划分到根目錄下。

  根目錄下常用的文件如下:

    src

    test

    doc

    dep

 

五、業務邏輯划分src目錄結構

  業務項目的src目錄內,絕大多數情況應該根據業務邏輯划分目錄結構。

  業務邏輯下常用的文件如下:

    utils

    common    

    components

    routers

    assets

    api

    store

    view

    static

  注意:這是按照vue/react進行的划分,不是固定的,個人習慣。

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM