2103230 B本は略語を使わない


今日は久しぶりにb本をします.
なんで嬉しいんだろう…本よ...
これは略語を書かない章です.
略語は一つの字名よりさらに進んだ形式で、世界には無数の略語がある.
TILも略語...ASAP、FYI、TGIFなどがあります.
日常生活では略語はよく使われていますが、コード内では略語は使わないほうがいいです.
たとえば、
class Logbook {
 static final Path DIR = Paths.get("/var/log");
 static final Path CSV = DIR.resolve("stats.csv");
 static final String GLOB = "*.log";
 
 void createStats() throws IOException {
  try (DirectoryStream<Path> dirStr = Files.newDirectoryStream(DIR, GLOB);
  BufferedWriter bufW = Files.newBufferedWriter(CSV)) {
    ...
 }
}
以上のコードにはDIR、CSV、GLOB、dirstr、bufw略語が多く使われています.
意味を正しく理解するのは難しい.
理解できる人もいるが、全部ではない.私のように.
脈絡が分からないとbufw,dirstrの意味がわかりにくい.
では、サムネイルはどのように交換すればいいのでしょうか.
class Logbook {
 static final Path LOG_FOLDER = Paths.get("/var/log");
 static final Path STATISTICS_CSV = LOG_FOLDER.resolve("stats.csv");
 static final String FILE_FILTER = "*.log";
 
 void createStats() throws IOException {
  try (DirectoryStream<Path> logs = Files.newDirectoryStream(LOG_FOLDER, FILE_FILTER);
  BufferedWriter writer = Files.newBufferedWriter(STATISTICS_CSV)) {
    ...
 }
}
ルールは当然です.
一般的な略語のみを使用し、フルネームも使用します.
上のコードを見ると、もっと分かりやすく、変な変数も見えません.
略語で書かれたDIRとGLOBは、略語ではない簡潔な名前に変更されました.
FILE FILTERはGLOBよりも変数の意図を伝えられる
すべての略語が使われるわけではありません.
bufwの場合、フルネームはwriterのみが使用されます.
要約はなるべく省略せず、ごく普通の場合にのみ使用してください.
もしあなたが不確実なら、解いて使います!
今日のコメント:先日コードをコメントしたときにNAMEについてのコメントもありました非常に難しい名前です.