ファイルの冒頭コメントにはこのようなもの書け!
- 1 :デフォルトの名無しさん:2022/07/29(金) 22:58:31.25 ID:CM0GSjVh.net
- 最も大切なのは、ソースファイルや設定ファイルなどの冒頭に、
動作に差し支えのない範囲でコメントを残すことだ。
そこに、次の情報を含める。
・ このファイルの名前
・ このファイルの概要(何をするものかを簡潔に)
・ 最終編集時に施した修正内容
・ 最終編集者(最終編集者以外は書かない)
・ 最終編集日(最終編集日以外は書かない)
■ソースファイルなどの冒頭に記すべきコメントの例
#######################################
#
# プログラムや設定ファイルの名
# そのプログラムの概要
#
# その他のコメント……
# ・このリビジョンで何をしたのか
#
# Written by 最終編集者on 最終編集日
#
#######################################
プログラムの途中にコメントを残すのもよいが、冒頭にも残す。
途中に書いてあるだけでは、書いてある場所を探すのが手間だ。
また、最終編集した際の日付と人(メールアドレスなど)も記す。
長年経った時に、そのリビジョンをいつ誰が作成したのか把握するためだ。それが他人であった場合、
わからないことがあればその者に聞けばいい。だたし、複数人で手を入れていたとして、
最終編集者でない者の名前や日付を残す必要はないし、むしろ消すべきだ。
歴代の担当者が知りたくば、リポジトリーに残っている過去のリビジョンを見れば済む。
同様の理由で、修正前のコードをコメントアウトした状態で残す悪習も止めること。
- 34 :デフォルトの名無しさん:2022/08/01(月) 20:47:31.22 ID:4FsRzH2f.net
- >>33
読んだ。で?
レス早くしてね
- 35 :デフォルトの名無しさん:2022/08/02(火) 22:18:30.01 ID:A3tAvDnU.net
- 有名なオープンソースソフトウェアでもこういうコメントがガリガリ書いてあったりする。
- 36 :デフォルトの名無しさん:2022/08/03(水) 05:31:38.47 ID:QPX5aNyT.net
- >>35
理由を検討したいので教えて
たぶん単に古いコードが残ってるとか
著作権情報と勘違いしてるだけでしょ?
- 37 :デフォルトの名無しさん:2022/08/03(水) 12:47:59 ID:RVMpqrdX.net
- >>35
それライセンスだよ
- 38 :デフォルトの名無しさん:2022/08/04(木) 17:32:05.72 ID:kI29Y1SH.net
- >>36
共同作業だと、そのファイルそのものに書いてあった方がうまくいくことが多い。
- 39 :某プログラマ:2022/08/04(木) 18:17:54.09 ID:+TMVVsOn.net
- もうコメントなんて見る人が分かりやすければ気にする必要は皆無
- 40 :デフォルトの名無しさん:2022/08/04(木) 18:41:04.01 ID:kI29Y1SH.net
- コメントが書けないようなレベルのプログラマが多いということだ。
- 41 :デフォルトの名無しさん:2022/08/04(木) 19:04:02.34 ID:BJlxUEs+.net
- >>38
質問したのはどのオープンソースプロジェクトかって話ね
ないよね?共同作業だとそんな事したら
最後にタイポの修正した人が編集者になるからねw
- 42 :デフォルトの名無しさん:2022/08/04(木) 19:06:14.05 ID:BJlxUEs+.net
- >>40
ユニケージの人たちって、
コメントにコードの意味を書いてるから
馬鹿な人達だなぁって思ってるw
自分が書いたコードの意味がわからないんだよね
コメントはコードに書いてないものを書くのにね。
- 43 :デフォルトの名無しさん:2022/08/04(木) 19:16:53.11 ID:kI29Y1SH.net
- サクラエディタのソースコードでも読んどけ
- 44 :デフォルトの名無しさん:2022/08/04(木) 19:18:41.71 ID:kI29Y1SH.net
- >>42
自己紹介がキチガイとは
- 45 :デフォルトの名無しさん:2022/08/04(木) 19:22:05.78 ID:BJlxUEs+.net
- そういやユニケージは
サクラエディタが推奨エディタらしいねw
- 46 :デフォルトの名無しさん:2022/08/04(木) 23:17:54.29 ID:KJ7UAuj1.net
- VScodeとか使い方わからないんだろうなぁ
- 47 :デフォルトの名無しさん:2022/08/04(木) 23:30:19.48 ID:isEYuHXY.net
- >>46
VSCodeは日本語のキャラクタセットがまだまだ苦手だからな。
- 48 :デフォルトの名無しさん:2022/08/05(金) 04:55:10.18 ID:NatsYXP2.net
- なにをするにも20年以上前の知識だよねw
- 49 :デフォルトの名無しさん:2022/08/05(金) 08:37:22.16 ID:KgIsFrhc.net
- >>47
いつの話だよ
- 50 :デフォルトの名無しさん:2022/08/05(金) 15:07:57.12 ID:Bo4EfhoE.net
- いまだってデフォルトではSJISに対応できない
- 51 :デフォルトの名無しさん:2022/08/05(金) 16:11:42 ID:wTrB/zGp.net
- デフォルトから設定変えられない馬鹿っているよねw
- 52 :デフォルトの名無しさん:2022/08/05(金) 16:27:14 ID:Bo4EfhoE.net
- >>51
設定じゃないから
- 53 :デフォルトの名無しさん:2022/08/05(金) 16:36:06.65 ID:wTrB/zGp.net
- プラグイン?どちらにしろ誰かにあてがってもらわないと
使えないなら無能なことに変わりない
- 54 :デフォルトの名無しさん:2022/08/05(金) 17:18:45.97 ID:Bo4EfhoE.net
- 日本語みたいなマイナー言語は無視という流れだからな。
- 55 :デフォルトの名無しさん:2022/08/05(金) 18:55:05.41 ID:wTrB/zGp.net
- コアに入れるのは小さくするのが今流のやり方
- 56 :デフォルトの名無しさん:2022/08/05(金) 22:01:18.04 ID:x2QrbwhX.net
- ファイル名やディレクトリ名を日本語にするな
- 57 :デフォルトの名無しさん:2022/08/05(金) 22:03:08.73 ID:WrK5iPKw.net
- Linux システムは、BOM 無しUTF-8 のみ
世界中で、CP932/sjis を使っているのは、5ch だけw
- 58 :デフォルトの名無しさん:2022/08/05(金) 22:27:16.92 ID:nqm59kVr.net
- >>57
windows「確かに」
- 59 :デフォルトの名無しさん:2022/08/06(土) 00:29:24.75 ID:QmLwYXDW.net
- 今どきSJISとかEUC-JPとかを使わなきゃいけない状況で仕事するのは、純粋に辛そう。
もちろん組込とかでそういう縛りのある分野もあるのはわかるけど、Unicodeじゃないなんて辛すぎる。
- 60 :デフォルトの名無しさん:2022/08/06(土) 01:13:22.33 ID:gdWnN+Oj.net
- >>59
EOSで新環境に移行するけど古ーーーいプログラムがEUC-JPです←まあわかる
変換面倒なので新環境もEUC-JPで構築します←えっっっっ
なことがあったわ
- 61 :デフォルトの名無しさん:2022/08/06(土) 03:45:44 ID:VmF/VxYx.net
- >>58
Windowsは多言語対応
SJISはおまえのための設定
- 62 :デフォルトの名無しさん:2022/08/06(土) 13:45:24.73 ID:xsmVc9Uv.net
- UTF-16の2バイト1文字ですべて収まると思われていた時代に普及してしまったから仕方ない。
- 63 :デフォルトの名無しさん:2022/08/06(土) 15:29:43.60 ID:eSBCWCwI.net
- 多言語であることと
多CPであることは
関係ないぞ
- 64 :デフォルトの名無しさん:2022/08/06(土) 15:43:36.92 ID:npHa04FT.net
- だからファイル名やディレクトリ名は単純な7ビット文字で書けって
日本語はまだいいほうでヨーロッパ文字で書かれると見分けがつかないし変な重複ファイルになっておかしなバグの原因になる
- 65 :デフォルトの名無しさん:2022/08/06(土) 15:46:33.31 ID:xsmVc9Uv.net
- >>63
なぜUnicodeという名前なのか考えたことがあるのか?
- 66 :デフォルトの名無しさん:2022/08/06(土) 15:51:38.85 ID:xsmVc9Uv.net
- Unicodeの「Uni」は当初は一文字を16ビットで揃えるという考えだったが、16ビットでは不可能とわかって、Unicodeの定義が変わった。
- 67 :デフォルトの名無しさん:2022/08/20(土) 04:00:42.50 ID:zzRI9puY.net
- まあ気持ちはわかる
経験少ないエンジニアは後任や自身があとでメンテするのに必要なコメント書かないからな
一番笑ったのはスピード自慢のpgがコメント全く書かずに自分でもどこで何やったか全くわからなくなってバグ解析お手上げになった案件w
焦ってgitの履歴とにらめっこしてるの見て更に爆笑w
- 68 :デフォルトの名無しさん:2022/08/20(土) 13:48:34.83 ID:kiVzxibA.net
- バカにされてるのはコメント書かないことじゃなくて、
自分が書いたコードの意味を日本語で説明しなきゃならんのかってところなんだよな
あとバージョン管理されてる情報はコメントで書く必要ない
- 69 :デフォルトの名無しさん:2022/08/20(土) 13:50:10.52 ID:kiVzxibA.net
- >>67
gitの履歴にらめっこできるのは良いポイントだよね
同じ状況になった時、git管理してないとお手上げになる
- 70 :デフォルトの名無しさん:2022/08/20(土) 21:31:32.66 ID:KukTSzUb.net
- >>69
git履歴もなんにもコメント残してなかったから結局お手上げ
時間のムダたった
その後はPLの俺が根気よく読み解いて全体の半分は書き直したよ
自分のコードも読めない自惚れPGにはまず要所要所にコメントを書くことを学んでほしい
俺は案件さすらいのPM/PLだからそいつがその後成長できたかはしらんけど
よくまああれでフリーランス何年もやっとるなと驚いたもんだ
- 71 :デフォルトの名無しさん:2022/08/20(土) 23:53:56.99 ID:+S84RQLD.net
- コメントではなくてドキュメント
つまり設計書とかまったくなしでやるのかい?
- 72 :デフォルトの名無しさん:2022/08/21(日) 02:28:42.91 ID:03eMfefm.net
- バージョン管理ツールの履歴があるからいいんだというやつは、間違いなく履歴を調べて元の仕様を確認したことがないやつ。
履歴が残っていても、それがどういう状態のものなのかわからないと意味がない。
- 73 :デフォルトの名無しさん:2022/08/21(日) 03:07:44.91 ID:Esm1hcin.net
- >>70
それとgitを使うこととは関係ないよねw
- 74 :デフォルトの名無しさん:2022/08/21(日) 03:08:26.71 ID:Esm1hcin.net
- >>72
はいはい。コメントあっても無駄なコメントありますね
i++ // 一増やす
とかさぁwww
- 75 :デフォルトの名無しさん:[ここ壊れてます] .net
- ExcelとかVBA界隈に多いな
- 76 :デフォルトの名無しさん:[ここ壊れてます] .net
- コードとコメントが仕様書であり実装である
- 77 :デフォルトの名無しさん:2022/08/21(日) 22:03:50.60 ID:uZ3gaybc.net
- 要件定義書、基本設計書、仕様書(詳細設計書)、gitコメント、ソースコメントそれぞれ書くべきことがある
区別できないのはアマチュア
- 78 :デフォルトの名無しさん:2022/08/21(日) 22:33:01.56 ID:0v7G3Tlr.net
- >>74
入門書に書いてあるコメントを書くのがコメントだと勘違いしているプログラマは多い。
- 79 :デフォルトの名無しさん:2022/08/24(水) 09:56:43.02 ID:ae0BiM/q.net
- >>1
∧__∧
( ・ω・) いやどす
ハ∨/^ヽ
ノ::[三ノ :.、
i)、_;|*く; ノ
|!: ::.".T~
ハ、___|
"""~""""""~"""~"""~"
- 80 :デフォルトの名無しさん:2023/06/08(木) 03:33:04.13 ID:+yzGlE16.net
- そのプログラムを一番早く確実に解読するために必要な情報をコメントするんだったら、別にルールに縛られずに好きに書いてもいいだろ?
初心者マークの付いたようなコメントでも必要とされる場合もある。初心者レベルのコメントが不要と笑う者は、そんなコメント無視できるくらいの器を持てよ。
自分はVHDLのプログラムを初めて書いたときに文法もよく分からなかったから教科書に載っているような内容も細かく書いてたけど、随分役に立ったし、他の人が見ても分かりやすいと評判だったよ。なにより、他の初心者が参考にしてくれてみんなスキルが上がっていったのが1番良かった。
上級者が読んでも、うん、理解して書いてるな、と安心して貰えたらしい。
- 81 :デフォルトの名無しさん:2023/06/14(水) 21:16:49.65 ID:g0g2T+lXO
- (入れてはならない政党5大税金泥棒政策)
観光促進…温室効果カ゛スに騷音にコロナにとまき散らして気侯変動災害連發させて国土破壞して人を殺して儲ける強盗殺人推進腐敗テ囗國家な
軍備拡張‥ウクライナは軍事費GDP比4%超で脅威視されて攻撃されたわけか゛.白々しく挑發して軍拡利権を獲得したい岸田異次元増税文雄
金融緩和…資本家階級資産倍増.もはやひとりて゛資産1兆円超,末代まで揺らく゛ことのない圧倒的格差社会優越的地位濫用促進政策な
孑供給付‥全国航空騷音まみれで勉強まで妨害しなか゛ら.貧乏人に不幸な子を産み落とさせて遺棄を推進する国家犯罪地球破壞人殺し政策な
正しい子供政策とは、ひとり産むこ゛とに5千万課税.払える見込みがなけれは゛日当5千圓て゛塀の中から子に送金させることだろ
原發稼働…クソポリへリ含むクソ航空機バンバン飛は゛しまくって莫大な石油を無駄に燃やしまくって威力業務妨害による知的産業壞滅によって
システム障害まみれのポンコツ腐敗後進國か゛笑わせよる。テ囗リス├自民公明か゛第ニのフクシマ利権確保したいだけなのか゛ハ゛レハ゛レ
創価学会員は,何百万人も殺傷して損害を与えて私腹を肥やし続けて逮捕者まて゛出てる世界最惡の殺人腐敗組織公明党を
池田センセ―か゛囗をきけて容認するとか本気て゛思ってるとしたら侮辱にもほと゛か゛あるぞ!
hтΤρs://i、imgur、сοm/hnli1ga.jpeg
- 82 :デフォルトの名無しさん:2023/06/29(木) 08:03:37.75 ID:szIurvDh.net
- 漠∞!!!!
斗∞!!!!!
及∞!!!!!!
山∞!!!!!!!
- 83 :デフォルトの名無しさん:2023/12/10(日) 22:07:39.56 ID:k+fj/wPfG
- 税金泥棒だらけの日本の茶番政治家と違って日本に原爆落とした世界最惡のならず者国家の国会は政治やってるよな
何しろ「やんのかコラ」『よろこんで」「じゃあ立てよ」「お前が立てよ」とか言い合ってるくらいだしな
岸田異次元増税憲法カ゛ン無視地球破壊覇権主義経済音痴文雄にそのくらい言い放とうものならお前ら間違いなく投票するよな
クヒ゛にされた税理士神田憲次財務副大臣は徴税システムぶっ壊すために財務副大臣になったんだくらい言えばどんでん返しだったろうに
天下り賄賂癒着して航空騷音による威力業務妨害までしてるだけの害虫公務員に高額なタダメシ食わしてやるデタラメ許してるせいで
賃金が上がらず物価上昇という白々しい結果になってんだから片っ端から税金という名目の強盗システムをぶっ壊してやんよとか
誰か言ってみせろっつのな、税金不払い運動とかやらないのは日本くらいなものだから俺も俺もと汚職まみれの世界最惡の腐敗天国に
なったわけた゛が税金滞納して督促くらってもどうということはないと税理士副大臣がバラしちまったし俺も俺もと誰も払わなくなればいいよな
(羽田〕ttрs://www.Сall4.jΡ/info.php?Τype=iTems&id〓I0000062 , ttps://hanеda-project.jimdofree.com/
(成田)ttps://n-souonhigaisosуoudan.amеbaownd.com/
(テロ組織)tТps://i.imgur.Com/hnli1ga.jpeg
22 KB
新着レスの表示
掲示板に戻る
全部
前100
次100
最新50
read.cgi ver 2014.07.20.01.SC 2014/07/20 D ★