代碼編程規(guī)范有哪些？原則是什么？

1、前言

關(guān)于代碼編程規(guī)范，從上篇了解到編程規(guī)則和編程規(guī)范的區(qū)別后，那么這篇介紹一下代碼編程規(guī)范包括什么、具體有哪些原則。

2、范圍

1 排版風(fēng)格

代碼規(guī)范化中的排版基本上有七大風(fēng)格，主要體現(xiàn)在縮進(jìn)、空行、代碼行、空格、成對(duì)書寫、對(duì)齊、注釋七方面的書寫規(guī)范上。

2 命名方式

主要包括文件名、類、函數(shù)、變量和接口等方面

3 注釋風(fēng)格

主要包括注釋、文件注釋、類注釋、方法注釋、參數(shù)注釋、變量注釋和代碼片段注釋等

4 其他的擴(kuò)展

包括接口頭文件的布局、函數(shù)的功能、變量的用途、宏定義、復(fù)合表達(dá)式、if判斷、循環(huán)語句、和類型定義等等

3、原則

1 清晰第一

清晰性是易于維護(hù)、易于重構(gòu)的程序必需具備的特征，一般情況下，代碼的可閱讀性高于性能，只有確定性能是瓶頸時(shí)，才應(yīng)該主動(dòng)優(yōu)化

2 簡(jiǎn)潔為美

代碼越簡(jiǎn)單越好，代碼一行只做一件事，一個(gè)函數(shù)只完成一個(gè)功能等，代碼越長(zhǎng)越難以看懂，也就越容易在修改時(shí)引入錯(cuò)誤

3 選擇合適的風(fēng)格，與代碼原有風(fēng)格保持一致

因?yàn)?a class="article-link" target="_blank" href="/tag/%E8%BD%AF%E4%BB%B6%E5%BC%80%E5%8F%91/">軟件開發(fā)不可避免要維護(hù)他人代碼或者和他人合作開發(fā)，此時(shí)就需要盡可能和與原有代碼風(fēng)格保持一致或者和合作者達(dá)成共識(shí)的代碼風(fēng)格，否則每個(gè)人都使用自己的代碼風(fēng)格，在閱讀時(shí)變得十分吃力

4 注釋一定要和代碼保持同步

很多情況下，代碼功能修改后，都忘記修改注釋，容易導(dǎo)致過段時(shí)間自己回頭看過于糾結(jié)注釋和功能不一致的情況