আমি অনুমান করছি যে আমি যা জিজ্ঞাসা করছি তা হল, আমার কোডটি যথাযথভাবে ডকুমেন্টেড এবং অন্য লোকেরা ব্যবহার করার জন্য যথাযথভাবে শব্দযুক্ত তা নিশ্চিত করার সর্বোত্তম উপায় কী হবে?
ওপেন সোর্স হিসাবে, সবার গুরুত্বপূর্ণ মন্তব্যগুলি হ'ল কপিরাইট এবং লাইসেন্স চুক্তির মন্তব্য agreement প্রতিটি ফাইলের শুরুতে একটি দীর্ঘ দীর্ঘ মন্তব্যের পরিবর্তে, আপনি একটি সংক্ষিপ্ত এবং মিষ্টি একটি ব্যবহার করতে চাইতে পারেন যা সংক্ষিপ্তভাবে কপিরাইট নির্দিষ্ট করে এবং পাঠককে মূল ডিরেক্টরিতে লাইসেন্স.txt এ রেফার করে।
আমি জানি আপনার সর্বদা সবকিছুর মন্তব্য করা উচিত এবং আমি প্রতিটি পদ্ধতির জন্য @params বৈশিষ্ট্যটি যুক্ত করতে যাচ্ছি, তবে সাধারণভাবে অন্য কোনও টিপস রয়েছে?
সব মন্তব্য? না। কোডটি যা সত্যই মন্তব্য করার প্রয়োজন নেই। স্বচ্ছভাবে মন্তব্য করুন। কোডের একটি অংশের সম্ভাব্য ব্যবহারকারী হিসাবে, শ্রেণীর সংজ্ঞাটির নিম্নলিখিত দুটি সংস্করণগুলির মধ্যে কোনটি আপনি দেখতে পছন্দ করবেন?
সংস্করণ এ:
class Foo {
private:
SomeType some_name; //!< State machine state
public:
...
/**
* Get the some_name data member.
* @return Value of the some_name data member.
*/
SomeType get_some_name () const { return some_name; }
...
};
সংস্করণ বি:
/**
* A big long comment that describes the class. This class header comment is very
* important, but also is the most overlooked. The class is not self-documenting.
* Why is that class here? Your comments inside the class will say what individual parts
* do, but not what the class as a whole does. For a class, the whole is, or should be,
* greater than the parts. Do not forget to write this very important comment.
*/
class Foo {
private:
/**
* A big long comment that describes the variable. Just because the variable is
* private doesn't mean you don't have to describe it. You might have getters and
* setters for the variable, for example.
*/
SomeType some_name;
public:
...
// Getters and setters
...
// Getter for some_name. Note that there is no setter.
SomeType get_some_name () const { return some_name; }
...
};
সংস্করণ এ-তে আমি সমস্ত কিছু নথিভুক্ত করেছি - ক্লাস নিজেই। সাধারণভাবে একটি শ্রেণি স্ব-ডকুমেন্টিং হয় না। সংস্করণ এ-তে উপস্থিত মন্তব্যগুলি একেবারে অকেজো, বা অকেজো থেকেও খারাপ। "মন্তব্য সব কিছু" মনোভাবের সাথে এটিই মূল সমস্যা। প্রাইভেট ডেটা সদস্য সম্পর্কে এই ক্ষুদ্র মন্তব্যটি কোনওভাবেই যোগাযোগ করে না, এবং প্রাপ্তির উপর ডক্সিজেনের মন্তব্যগুলির নেতিবাচক মূল্য রয়েছে। প্রাপ্তিget_some_name() সত্যিই একটি মন্তব্য দরকার নেই। এটি কী করে এবং কী ফিরে আসে তা কোড থেকে স্পষ্টভাবে সুস্পষ্ট। যে কোনও সেটটার নেই - আপনাকে এটি অনুমান করতে হবে কারণ এটি সেখানে নেই।
বি সংস্করণে আমি নথিবদ্ধ করেছি যা মন্তব্য করা প্রয়োজন। গেটারের কোনও ডক্সিজেন মন্তব্য নেই, তবে এতে কোনও সেটর নেই বলে উল্লেখ করে একটি মন্তব্য রয়েছে।
আপনার মন্তব্যগুলি গণনা করুন এবং সাবধান হন যে কোডগুলিতে পরিবর্তনগুলি প্রতিবিম্বিত করার জন্য মন্তব্যগুলি প্রায়শই সময় ধরে রাখা হয় না।