公司技術規範模板

2021-09-12 15:12:04 字數 882 閱讀 6697

1. 1. 本規範分為二個章節

1. 2. 語言

本文中用到的關鍵字必須=強制。不能=強制。要求=強制,如果有特殊情況,需要商討後決定是否可以解除此次強制。應該=不強制,但如果不遵守,可能會出現意外情況。不應該=不強制,但如果不遵守,可能會出現意外情況。推薦=不強制,根據經驗總結出的相對較好的方案, 可以不遵守。可以=不強制,明確指定允許做的事情。可選=不強制,任選其一,可以都不選擇。

1. 1. 推薦:不使用雙重否定

目的:1.增加可讀性

例如 :

(錯誤示例) 1.isnotfoundnotexistbykey(是否找不到不存在的key )

(正確示例) i***istbykey(是否存在key )

1. 2. 推薦:db層的api命名 計數方法count作為字首,查詢方法find作為字首,增加方法insert作為字首,修改方法update作為字首,刪除方法delete作為字首

目的:1.為aop做鋪墊。2.增加可讀性。3.與業務隔離

注: api指對外暴露的服務名稱

計數方法指 count(*),只返回個數的查詢方法

目的:1.為讀寫分離的資料來源aop做鋪墊。2.增加可讀性。3.與業務隔離

1. 4. 推薦:自2023年3月8日後新編寫的**,db服務sql只允許寫在xml檔案中。

目的:1.增加可維護性。

1. 1. 推薦:用巢狀查詢替代掛表查詢(特別是大表!)

目的:1.增加效能。2.優化磁碟io

反例:正例:

TrackBack 技術規範

原文是trackback technical specification,此處是譯文 竹筍炒肉譯 名稱 mttrackback trackback 技術規範 作者benjamin and mena trott,movabletype.org 版本1.1 描述 本文描述了trackback,乙個點對點...

RSS技術規範簡介

rss really syndication 是xml 是一種資料格式,允許使用者查詢web內容而不必訪問 rss提供了web資料的乙個檢視,新內容會自動向使用者傳送這個檢視。特定資料集上的rss檢視稱為rss提要 rss feed 或新聞提要 newsfeed 檢視rss提要,需要rss新聞閱讀器...

XML 及相關技術規範

xml基本規範 xml1.0 xml1.1 xml關聯技術規範 dtd xml命名空間 xml schema xpath xsl xslt xlink xpointer xquery dom sax等 xml應用規範 xhtml svg smil mathml gml rddl xbl xbrl r...