私は過去6年間プログラミングをしています。私は最近、コンピュータサイエンスの最初の学位を取得しました。私の作品は、さまざまな理由で絶えずマークダウンされているようです。
- コメントされていないコード
- 長すぎる識別子の名前とメソッドを書く
- あまりにも多くのメソッドを書く
多くのスタートアップ企業で6年間プログラマーとして働き、「自明のコード」を書くという要件を含むベストプラクティスを吸収した後、悪いプラクティスに戻るのは非常に難しいと思います。
私に何ができる?
私は過去6年間プログラミングをしています。私は最近、コンピュータサイエンスの最初の学位を取得しました。私の作品は、さまざまな理由で絶えずマークダウンされているようです。
多くのスタートアップ企業で6年間プログラマーとして働き、「自明のコード」を書くという要件を含むベストプラクティスを吸収した後、悪いプラクティスに戻るのは非常に難しいと思います。
私に何ができる?
自己文書化されたコードはコメントと同義ではありません。
私はこの点について多くの上級開発者と議論してきました。コードは意図を伝えるのに大いに役立つ可能性がありますが、コードを介して文書化できない(そして文書化すべきではない)ことがいくつかあります。
たとえば、高度に最適化された関数/メソッドまたはコードのチャンクがあり、根本的な問題ドメインと密接に関連しており、ビジネスまたはソリューションに関する非常に具体的な知識が必要な場合です。これらのシナリオではコメントが必要です。
はい、はい、コメントにはかなりの割合の問題が伴いますが、これはそれらが役に立たない(または特定の場合には必須である)という意味ではありません。
同僚のコード行を読んで「一体何だ?!?」と思った回数はわかりません。私たちがターゲットにしていたライブラリやブラウザの癖などのために、それを行う必要があることを説明するためだけに。
コメントは、開発者が設計上の決定を正当化するためのメカニズムです。
あなたの他の問題に関しては、それらは主観的です。どれくらい長すぎますか?いくつ多すぎますか?MSスタックを使用している場合、または使用している言語に関係なく無数の記事がある場合は、Microsoftのガイドラインを参照してください...
お役に立てば幸いです。