更新履歴¶

第1単語 + 第2単語 + 第3単語で基本的に構成
命名には、多くても 2つの _(アンダーバー) で必ず構成する
e.g.): lip_jtA_GpL
e.g.): lip_jtA
e.g.): lip_geo, lip_rigGeo
第1単語, 第2単語は必ず小文字で始まる、ローワーキャメルケース記述を基本とする
e.g.): lip_jt
e.g.): lip_geo, lip_rigGeo, lip_jtA_GpL
第3単語は必ず大文字で始まる、アッパーキャメルケース記述を基本とする
e.g.): lip_jtA_GpL, lip_jt_AL, lip_jtA_L
識別子は、必ず大文字で始まり、第3単語で使用する事を基本とする
識別子とは、
-a. ナンバリング用識別子
-b. 文字列 Gp 識別子（グループの意
-c. サイド用識別子
を想定しています
e.g.): "A", "B", "L", "R", "Gp" ....
-a. ナンバリング用識別子は第1単語第2単語第3単語どこで使用しても構わないが、2個以上存在してはいけない
以下は NG です
NG. ): lip_jt@_@L, lip@_jt@_L

●英語とIT用語のマメ知識

英語のマメ知識

英語の略語で使用頻度の高いもの

例えば
e.g.

記述例

e.g.): XXXXXXX
なぜならば
b/c

記述例

b/c): XXXXXXX
注意(注意喚起)
note

記述例

note): XXXXXXX

●reStructuredText(docstring)-style チート
pythonコーディングにおけるコメントアウト内の記述styleの一つです。
当方は、reStructuredText 通称 RST 記述styleで統一しています。sphinxもこれに属するようです。
他の記述styleには、

Google-style
Numpy-style

があります。

チート

参考ガイド早わかり reStructuredText
参考ガイド Documentation Formats reStructuredText
参考ガイド Documentation Formats
参考ガイド Auto documented class (method 1)

¶

以上

最終更新日: 2024年4月18日 10:13:55

更新履歴¶

<2024-04-18 10:13:35> 概要(Summary): Commit d1cb6eb, MkDocs 1.5.2. And --dirty. And 60_Mkdocs&Github pages を更新.tech_memo¶

<2024-04-18 09:54:06> 概要(Summary): Commit 1851080, MkDocs 1.5.2. And --dirty. test check.¶

当サイトについて...¶

概要¶

site map¶

記憶のトビラ¶

¶

<2024-04-18 10:13:35> 概要(Summary): Commit d1cb6eb, MkDocs 1.5.2. And --dirty. And 60_Mkdocs&Github pages を更新.
tech_memo
¶

<2024-04-18 09:54:06> 概要(Summary): Commit 1851080, MkDocs 1.5.2. And --dirty. test check.
¶