প্রথম ব্যক্তি কি মন্তব্যগুলি বিভ্রান্তিকর এবং পেশাদারহীন?


63

আমি সবেমাত্র কিছু (প্রত্নতাত্ত্বিক ভিজ্যুয়াল বেসিক .0.০) কোডটিতে লিখেছিলাম যা লিখেছিলাম:

If WindowState <> 1 Then
    'The form's not minimized, so we can resize it safely
    '...
End if

আমি নিশ্চিত না কেন আমি কেন আমার মন্তব্যে অবচেতনভাবে "আমরা" ব্যবহার করি। আমি সন্দেহ করি কারণ আমি ধারণা করেছি যে কেউ কোডের মধ্য দিয়ে পদক্ষেপ নিচ্ছেন, যেন তারা কেবল প্রতিটি লাইনের সমস্ত কমান্ডকে কেবল "ঘটনামূলকভাবে" দেখার পরিবর্তে "কমান্ড" করছেন। এই মানসিকতার সাথে আমি ব্যবহার করতে পারতাম I can resize it, যেহেতু আমিই বর্তমানে এটি "করণ" করছি বা you can resize itভবিষ্যতে যেমন আমি কার সাথে কথা বলছি, তবে যেহেতু এই দুটি ক্ষেত্রেই সম্ভবত এটিই হবে ঘটে, আমি "আমরা" এমনভাবে ব্যবহার করি যেন আমি আমার কোডের মাধ্যমে অন্য কাউকে নেতৃত্ব দিচ্ছি।

আমি কেবল এটিকে আবার লিখতে পারি it can be resizedএবং বিষয়টি এড়াতে পারি, তবে এটি আমার কৌতূহলের জন্ম দিয়েছে: মন্তব্যগুলিতে এই জাতীয় ব্যক্তিকে ব্যবহার করা কি সাধারণ, না কি এটিকে বিভ্রান্তিকর এবং / বা অব্যক্তিকর বিবেচনা করা হয়?


1
ডাউনভোটের জন্য মন্তব্য? এটি আমার প্রথম প্রোগ্রামার্স.এসই প্রশ্ন, এবং আমি এখনও ভাল পি.এসই প্রশ্ন বনাম একটি ভাল এসও প্রশ্নটি কী করে ঠিক তা নির্ধারণ করার চেষ্টা করছি।
dlras2

2
আমি আপনাকে হ্রাস করি নি তবে আমি অনুমান করতে পারি যে তারা শিরোনাম প্রশ্নটি পছন্দ করেন নি কারণ এর উত্তরগুলি সহজেই সংক্ষিপ্ত, চ্যাটি এবং অতিরিক্ত মাত্রায় অনাবৃত মতামত দেওয়া যেতে পারে। আপনার চূড়ান্ত প্রশ্নের মতো এটির পুনর্নির্মাণ সাহায্য করতে পারে।
ডি কেটি

56
আমি 'আমরা' পছন্দ করি। এটি একটি বন্ধুত্বপূর্ণ এবং একটি পুষ্টিকর পদ্ধতিতে অন্তর্ভুক্তিমূলক।
জেরেমি

25
আমি মনে করি যে আমি তৃতীয় ব্যক্তি সর্বজ্ঞতে কাজ করি এমন সমস্ত বাগ ফিক্সগুলি নিয়ে মন্তব্য করা শুরু করব, আমাকে অফিসের চারপাশে জনপ্রিয় করা উচিত ... "জন কি জানেন না যে তার খারাপ নকশাকৃত সংযোজন সর্বদা এই কোডটি এড়িয়ে যাবে, ব্যবহারকারীরা হতবাক হয়ে গেল চিরতরে খালি প্রদর্শনের ক্ষেত্রের দ্বারা ... "
ডকনাইট

4
আমার মন্তব্যগুলি বোকা টাইপগুলি বাধা দেয় না তা নিশ্চিত করার জন্য আমি কেবল এটিই করতে পারি। প্যাসিভ ভয়েস ব্যবহার করা উচিত কিনা তা নিয়ে এখন আমার চিন্তা করা দরকার? এরপরে আমাকে নিশ্চিত করতে হবে যে আমি কোনও প্রস্তুতিগুলি ঝুঁকছি না - আমি কল্পনা করি যে এটি এমন কিছু যা আমার সহকর্মীরা নাও করতে পারে। এবং আমি মনে করি যে আমাকে কখনও কোনও বিভক্ত ইনফিনিটিভ ব্যবহার করার অনুমতি দেওয়া হবে না। সাজা টুকরা?
মাইকেল বুড়

উত্তর:


103

মন্তব্যগুলি মানুষের বোঝার জন্য লিখতে হবে। যখন মানুষ যোগাযোগ করে, আমরা সাধারণত "আমি", "আমরা", "আপনি" ইত্যাদি ব্যবহার করি

যখন কেউ কিছু কোড বোঝার চেষ্টা করছেন, তখন দু'জন বা আরও বেশি অভিনেতা রয়েছে: ব্যক্তি এটি পড়ছেন এবং কোডটির মূল লেখক। "আমরা" বলা ভাল। 'পেশাদার' না করে আপনার অর্থ 'রোবোটের মতো'।


3
এইভাবে লেখার ক্ষেত্রে +1 আপনাকে লেখককে সম্ভাব্য পাঠক বিবেচনা করতে উত্সাহ দেয় এবং এটি আপনাকে সত্যিকারের এমন ধারণাগুলি দেখতে সহায়তা করতে পারে যা আরও ভালভাবে ব্যাখ্যা করার প্রয়োজন হতে পারে।
জাস্টিন ওহমস

64
// we approve of this answer:)
জারোদ ডিকসন

3
+1 এবং একটি পরিবর্ধন: বিপরীতক্রমে, "এটিকে পুনরায় আকার দেওয়া যেতে পারে" এর মতো প্যাসিভ-ভয়েস নির্মাণগুলি সাধারণত আমাদের বুঝতে বুঝতে অসুবিধা হওয়ায় লিখিতভাবে প্রত্যাখ্যান করা হয়। আপনি যদি প্যাসিভ-ভয়েস ব্যবহার করেন তবে আপনি আপনার পাঠককে বাক্যটির জন্য একটি বিষয় আবিষ্কার করতে এবং মনে রাখতে বাধ্য করেন।
এমএসডাব্লু

1
@ এমএসডব্লিউ: তা কি '' এর আকার পরিবর্তন করা যায় '... এর মতো প্যাসিভ-ভয়েস নির্মাণকে প্রত্যাখ্যান করা উচিত নয় ...'?
টিডামার্স

2
@ এমএসডাব্লু, রাশিয়ান ভাষায়, উদাহরণস্বরূপ, প্যাসিভ ভয়েস কনস্ট্রাক্টগুলি আরও সাধারণ এবং কিছু সাংস্কৃতিক পার্থক্যের কারণে আরও সহজে বোঝা যায়। (এবং না, আমি না না উদ্দেশ্যমূলকভাবে কর্মবাচ্য যে বাক্য লিখতে!)
পি Shved

22

আমি 'আমি' ব্যবহার করা থেকে দূরে থাকার পরামর্শ দেব কারণ এটি কোডের জন্য স্বয়ংক্রিয়ভাবে সমস্ত দায়িত্ব গ্রহণ করে। অন্য লোকেরা যদি এটি পড়তে থাকে তবে এটি দেখতে খারাপ লাগবে কারণ এটি এই ক্ষেত্রে একটি দলের প্রচেষ্টা হতে বোঝায়। আমি 'আমরা' ব্যবহার সম্পর্কে উদাসীন। এটি অবশ্য অন্যান্য পাঠককেও যথাযথভাবে অন্তর্ভুক্ত করতে পারে।

আমার ভোট এখনও বংশবৃদ্ধি এবং সংক্ষিপ্ততার জন্য যায়। যদি বার্তাটি কম-শব্দভাবাপন্নভাবে জানানো যায় তবে কেন অন্য কিছু বেছে নিন? সুতরাং, এই উদাহরণ সম্পর্কে, আমি লিখতে হবে:

'The form is not minimized so it can be resized safely.

4
"যদি বার্তাটি কম-ভার্বোজ পদ্ধতিতে পৌঁছে দেওয়া যায় তবে অন্য কিছু কেন বেছে নিন?" যেহেতু কেউ কারও দুর্বল নথিভুক্ত গ্রন্থাগারগুলি বাস্তবায়নের চেষ্টা করার জন্য প্রাচীরের বিরুদ্ধে মাথা বেঁধে যেতে হয়েছে - ওপেন উত্স লিবগুলি এটির জন্য কুখ্যাত - আমি বলি যে আমি খুব অল্পের চেয়ে অনেক বেশি মন্তব্য করব। আমি মনে করি আমি আপনার সাথে একমত হয়েছি যদিও আপনি যদি বোঝাতে চাইছেন সঠিক বিরামচিহ্ন সহ ভাল বাক্য ব্যবহার করেন।
জোনাথন হেনসন

3
টিম সেটিংয়ে সমস্ত দায়িত্ব না নেওয়ার জন্য +1। এবং আমি ভার্বোজ মন্তব্য এড়ানোর চেষ্টা করার বিষয়ে একমত হওয়ার পরেও কখনও কখনও প্যাসিভ উত্তরণটি পড়তে আরও কঠিন হতে পারে (যেমনটি জেজেজে উল্লেখ করেছে) এবং কোনও কম ভার্বোস নেই, এবং আমি অবহেলা রোধ করতে পছন্দ করি। =]
dlras2

2
@ জোনাথন হেনসন: অনেক মন্তব্য ভাল, তবে তাদের মধ্যে প্রচুর দরকারী তথ্য থাকে। যদি একই পরিমাণের তথ্য দুটি সমতুল্য উপায়ে প্রকাশ করা যায় তবে সংক্ষিপ্ততরটি আরও ভাল।
টিডামার্স

আমার পরামর্শ হ'ল প্যাসিভ ভয়েস ব্যবহার করা এড়ানো। এটি বোঝা আরও বেশি কঠিন, বিশেষত অ-নেটিভ ইংলিশ স্পিকারদের পক্ষে।
ভিল লৌড়িকারি

18

আমি দুটি পদ্ধতির একটি গ্রহণ করি, সাধারণত যা ভাল মনে হয়।

প্রয়োজনীয়তা বা ন্যায্যতার মতো বিষয়গুলি ব্যাখ্যা করার ক্ষেত্রে, আপনি যেমন আছেন সেখানে আমি "আমরা" সাথে যাচ্ছি:

// We can't proceed unless the user has given us this information.

আমি যদি প্রক্রিয়াটি ব্যাখ্যা করছি, আমি একটি আবশ্যক (কমান্ড) ভয়েস ব্যবহার করার প্রবণতা রাখি (যদি ভুল শব্দটি হয় তবে আমাকে সংশোধন করুন):

// Get the foo from bar and make sure it follows our required format.

পরবর্তীটি কোডটি পুনরাবৃত্তি করার জন্য বিপজ্জনকভাবে কাছাকাছি যেতে পারে, তবে এর ব্যবহার রয়েছে। সুতরাং এটি আমি বা আমরা ব্যবহার করছি না, পরিবর্তে এটি "আপনি" বোঝায়।


এটিও ঠিক আমার স্টাইল। আপনি যে দুটি উপায়ে বর্ণনা করেছেন তার উভয় জায়গাতেই রয়েছে।
zourtney

9
পরেরটিরও এতে "আমাদের" রয়েছে। আমি এটি আকর্ষণীয় মনে করি যে লোকেরা স্বাভাবিকভাবে প্রথম ব্যক্তির বহুবচনগুলিতে মন্তব্য লেখেন।
রিড করুন

@ রিড বাহ্ হ্যাঁ এটি কেবল প্রবৃত্তি ছিল, আমি খেয়ালও করিনি। তবে এটি সহজেই "দ্য" বলতে পারত।
Tesserex

8

আমি মনে করি এটি একাডেমিক / প্রযুক্তিগত রচনার স্টাইলে কেবল একটি বৈচিত্র, যা প্রায়শই নৈর্ব্যক্তিক। প্যাসিভ ভয়েস ব্যবহার করে, "রয়েল উই" ব্যবহার করে ("এক" তাই তারিখযুক্ত)।

একটি সাধারণ নিয়ম অনুযায়ী, এটা হয় অ নির্দিষ্ট যারা যাহাই হউক না কেন ব্যবহার করে - রক্ষণাবেক্ষণকারীকে উপকৃত জন্য মন্তব্য, না স্বাভাবিকভাবে শুধু মূল লেখক জন্য।

তাই বলা হয়, আমি মন্তব্য বেশ প্রায়ই প্রথম ব্যক্তি ব্যবহার করেন - ব্যাখ্যা কেন আমি বিশেষ সিদ্ধান্ত, এবং কি আমি চিন্তা ছিল।


3
আমি ব্যক্তিগতভাবে মনে করি না যে "একজন" তারিখযুক্ত। হ্যাঁ, এটি খুব কম ব্যবহারে হয় না কারণ এটি এমন কিছু নয় যা সময়ে সময়ে কেউ ব্যবহার করে। তবে, কমেন্টের শূন্য হওয়ার সামান্যই সুযোগ নেই যে কোনও মন্তব্যে সেই অর্থে "একটি" ব্যবহার করা অপঠনযোগ্য হতে পারে বা অন্যথায় ব্যবহারযোগ্যতা থেকে বিরত থাকে।
বিলি ওনিল

7

মন্তব্যে আপনাকে বলা হবে যে কেন কিছু করা হচ্ছে, যা করা হচ্ছে তা নয়। যা করা হচ্ছে তা যদি কোড থেকে সুস্পষ্ট না হয় তবে কোডটি ঠিক করুন, কেবল একটি মন্তব্য যুক্ত করবেন না। প্রথম ব্যক্তি, দ্বিতীয় ব্যক্তি ইত্যাদি বিষয়গুলি গুরুত্বপূর্ণ নয়, কী গুরুত্বপূর্ণ জিনিসগুলি প্রয়োজনীয় তথ্য যোগাযোগ করে।

আপনি যদি কোডটি বর্ণনা করতেই চান তবে অপরিহার্য বিষয়গুলি পছন্দ করুন, যেমন

'ensure that the window is not minimized
If WindowState <> 1 Then
    'resize the window
    '...
End if

(এবং দয়া করে কোডে "1" এর মতো খালি স্ট্যান্ড্যান্ট ব্যবহার করবেন না)


3
জরুরী পছন্দ করার জন্য +1, আমি এটি ভাবিনি। এছাড়াও, হ্যাঁ, আমি খালি ব্যবহার করা উচিত নয় 1। আমি সাধারণত এটি সম্পর্কে বেশ ভাল ... ইন্টারনেটে আমার মন কেটে যায় কয়েকবারের মধ্যে একটি পোস্ট করার জন্য এটি আমার কাছে ছেড়ে দিন।
dlras2

6

সম্ভবত আমরা যাদুটি ঘটানোর জন্য প্রোগ্রামটির ভিতরে থাকা ছোট ছেলেদের উল্লেখ করছি? :)

ইংরেজি ভাষার প্যাসিভ ভয়েস ব্যবহার করা শক্ত এবং খারাপ লাগে। লোকেরা ব্যক্তি ফর্মগুলি ব্যবহার করতে পছন্দ করে (আমি, আপনি, আমরা, একটি)।

উদাহরণ:

(আপনার / আমরা / এক অবশ্যই) পিতা-মাতার কাছে উইন্ডো পুনরায় আকারের ইভেন্টগুলি পাস করার জন্য একটি প্রতিনিধি ব্যবহার করুন

উইন্ডো রিসাইজ ইভেন্টগুলি পিতামাতার কাছে পাস করার জন্য একটি প্রতিনিধি ব্যবহার করতে হবে

আরেকটি উদাহরণ (নোট করুন যে আপনি প্রায়শই মন্তব্যগুলিতে ব্যক্তি ফর্মটি বাদ দিতে পারেন):

(আমরা) একটি ব্যতিক্রম ধরা। (আমরা হব) একটি ত্রুটি সংলাপ দেখানো হচ্ছে।

একটি ব্যতিক্রম ধরা পড়ে এবং একটি ত্রুটি সংলাপ প্রদর্শিত হবে।

গীত। প্যাসিভকে "আপনি" দিয়ে প্রতিস্থাপন করা ইংরেজি ভাষায় এতটাই সাধারণ যে এটি অন্যান্য ভাষায়ও ফাঁস হতে শুরু করেছে। এটি অত্যন্ত মজার শোনায়, উদাহরণস্বরূপ, ফিনিশ যেখানে দ্বিতীয় ব্যক্তির একক রূপ উপস্থিত হয় (ইংরেজি "তুমি" এর মতো)।


আমি ভাষাতাত্ত্বিকভাবে মনে করি এটি সঠিক নয়। প্রথমটি জরুরী, এটির কোনও বিষয় নেই। "দরজা বন্ধ করুন." যদিও এটির অর্থ মোটামুটি একইভাবে "দয়া করে, আপনি কি দরজাটি বন্ধ করতে পারেন?" এটি একটি স্বতন্ত্র ব্যাকরণ রূপ, সংক্ষেপণ নয়। দ্বিতীয় উদাহরণে, আপনি ঠিক বলতে পারেন "(এটি একটি ব্যতিক্রম ধরা পড়েছে (
ইনকা

3

আপনি যদি প্রোগ্রামটির সম্পাদনার কথা বলছেন তবে এটি 'আমরা', 'আপনি' বা 'আমি' নয়। অ্যানথ্রোপোমর্ফিিজম এতোটুকু বিস্তৃত হতে পারে যে অকেজো হতে পারে না তবে এটি একটি বিপজ্জনক অভ্যাস (পিডিএফ সতর্কতা। ডিজকস্ট্রা সতর্কতা।):

আমি মনে করি নৃবিজ্ঞান সব থেকে খারাপ। আমি এখন প্রোগ্রামগুলি "জিনিসগুলি করার চেষ্টা করা", "জিনিসগুলি করতে চাই", "বিশ্বাসযোগ্য জিনিসগুলি সত্য হতে", "জিনিসগুলি জানার" ইত্যাদি দেখেছি language ভাষাটির এই ব্যবহার নিরীহ বলে বিশ্বাস করার জন্য এতটা নির্বোধ হয়ে উঠবেন না। এটি প্রোগ্রামারকে প্রোগ্রামটি সম্পাদন করে নিজেকে চিহ্নিত করার জন্য আমন্ত্রণ জানায় এবং প্রায় অপারেশনাল শব্দার্থ ব্যবহারের জন্য তার উপর চাপ দেয়।


2
ডিজকস্টারের সতর্কতা! যদি কেবলমাত্র আরও কিছু থাকে :(
টম অ্যান্ডারসন

আমি মনে করি না প্রথম ব্যক্তির বহুবচনতে মন্তব্য লেখা একটি নৃতাত্ত্বিক ধারণা। আমি মনে করি এটি সূচিত হয়েছে, "এখন আমরা কম্পিউটারকে ..." নির্দেশ দিই, যেন মন্তব্য লেখক প্রোগ্রামার তার কোডের মাধ্যমে পাঠককে নেতৃত্ব দিচ্ছেন।
blujay

2

আমি মনে করি না যে প্রথম ব্যক্তি বা "রাজকীয় আমরা" পেশাদারিত্বহীন, বা বিভ্রান্তিকর বলে মনে হচ্ছে। আমি যে আমরা ইংরেজী ভাষায় মন্তব্য লিখতে করার একটি প্রচেষ্টা করা উচিত মনে করি না ই-প্রধানমন্ত্রী ইংরেজির উপসেট যে, "হতে" ক্রিয়া ভোগদখল না।

আপনি যদি মন্তব্যে "হতে" অতিরিক্ত ব্যবহার করেন আপনি বিভ্রান্তিমূলক বক্তব্য পাবেন:

// X is 10
// X is the user data of the newly-authenticated user
// X is a BigInt

ঠিক আছে, সম্ভবত একবারে না, তবে সমতার দিক থেকে মন্তব্যগুলি সত্যই অস্পষ্ট করতে পারে।

আমি মনে করি যে ই-প্রাইমে লেখার প্রয়োজনীয়তাগুলি সেই প্রয়োজনীয়তাগুলি আরও স্পষ্ট করে তুলতে সহায়তা করে, কারণ লেখকের অবশ্যই অ্যাকশন সহ কোনও অভিনেতাকে ইঙ্গিত করতে হবে।


আকর্ষণীয় ধারণা; "এক্স কমপক্ষে 5 হওয়া উচিত" বা "ওয়াই অবশ্যই 23 এর চেয়ে বড় হওয়া উচিত না"?
ক্যাট

@ সুপের্যাট - "এক্সের মানটির দৈর্ঘ্য 5 বা তার বেশি হতে হবে"। "Y এর মান অবশ্যই 23 এর বেশি হবে না"। সমতা, যৌক্তিক বা পাটিগণিত, "হতে হবে" ক্রিয়াটি ব্যবহার করা উচিত নয়। "এক্সের অবশ্যই 5 থাকতে হবে" বা "এক্স এক্স 5 এর সাথে মূল্যায়ন করে" বা "এক্স এর মান 5 রয়েছে" বা সামসুচ। যদি আপনি একটি বিশেষ অস্পষ্ট মন্তব্য পেয়ে থাকেন তবে "হতে" ক্রিয়াগুলি সন্ধান করুন। আমি বাজি ধরছি যে অস্পষ্ট মন্তব্যটি লক্ষণীয় নয় তবে "হতে" ক্রিয়াপদ ব্যবহার করে। আরও মনে রাখবেন যে আমি উত্তরটি ই-প্রাইমে লিখেছি।
ব্রুস এডিগার

দ্বিতীয়টি ঠিক আছে; প্রথমটি এত বেশি নয়, যেহেতু -6 এর দৈর্ঘ্য 5 বা তার বেশি হয়।
ক্যাট

@ সুপের্যাট - খুব ভাল "এক্স এর স্বাক্ষরিত পূর্ণসংখ্যার মান 5 বা তার বেশি হওয়া উচিত"। মার্কিন যুক্তরাষ্ট্রে, আমরা আপনার "পরিধি" "পরম মান" বলব, যা ভেরিয়েবলের মান বর্ণনা করার ক্ষেত্রে আমার বক্তব্যকে শক্তিশালী করে, ভেরিয়েবল-অ-ভ্যালু, যা সমতা-সমতা থেকে উদ্ভূত হয়।
ব্রুস এডিগার

2

মন্তব্য করার সঠিক শৈলী তৃতীয় ব্যক্তি নৈর্ব্যক্তিক; " ফর্মটি ছোট করা হয়নি, তাই এটি নিরাপদে পুনরায় আকার দেওয়া যেতে পারে "।

  • আমি নিষ্পাপ।
  • আপনি ক্রেস।
  • আমরা খুব ফর্মাল (এবং রাজকীয়)।

প্রতিটি বাক্যকে এভাবে পুনরায় পুনঃবিবর্তিত করা যায় (উপরে দেখুন) এবং এটি লেখার একমাত্র পেশাদার উপায়।


11
-1 কারণ: কোনও সঠিক উপায় নেই, আমি আপনার / আমি / আমাদের সংক্ষিপ্তসারটি কিছুটা ছাপিয়েছি এবং শেষ অংশটি আমি বুঝতে পারি না। পাশে: আমি যখন আমার মন্তব্যে "আমরা" বলি, তখন আমি কোনও রাজার মতো কথা বলার চেষ্টা করি না - আমি আপনার সাথে কথা বলছি, লোকটি আমার কোডটি পড়ছে, এবং আমার চিন্তাভাবনাগুলি আপনাকে পাশাপাশি চলছে।
ডপপেলগ্রিনিয়ার

2

এটা মন্তব্য উপর নির্ভর করে।

সাধারণত, আমি একটি গরুর মুখের পরামর্শ অনুসারে মন্তব্য লিখি । আমি সবসময় ডকুমেন্টেশন-উত্পন্ন মন্তব্য (ডক্সিজেন, জাভাডক) এই পদ্ধতিতে লিখি।

যাইহোক, উত্স ফাইলগুলিতে কে / স্পর্শকৃত রেখাগুলি লিখেছে তা সনাক্ত করতে অনেকে প্রায়ই সংস্করণ নিয়ন্ত্রণের ব্যবহার অবহেলা করেন। এমন সময় আছে যখন "আমি" বলা উপযুক্ত, বিশেষত যখন কোডটি লিখেছেন তার কাছে "আমি" ট্র্যাক করা মোটামুটি সহজ when আপনি যদি কোনও ব্যক্তি হিসাবে কোনও সিদ্ধান্ত নেন, আমি কোডের সাথে সন্নিবেশিত সিদ্ধান্তগুলি সনাক্ত এবং সনাক্ত করতে "আমি" (সংস্করণ নিয়ন্ত্রণের সাথে) ব্যবহার করার পরামর্শ দিই।


ডোজিজেন এবং জাভাডকের জন্য +1। আমি সম্মত হই যে ডকুমেন্টেশন মন্তব্যগুলির চেয়ে পৃথক, (যদিও কিছু মন্তব্য ডকুমেন্টেশন তৈরি করে) এবং এই জাতীয় দলিলগুলি আমার মন্তব্যের চেয়ে আরও এক ধাপ আরও আনুষ্ঠানিক রাখতে আমি যথাসাধ্য চেষ্টা করি।
dlras2

1

আমার ভাল বৃদ্ধ বাবা (mhrip) জিজ্ঞাসা করবে: "আপনি বিরক্ত করার জন্য আরও গুরুত্বপূর্ণ জিনিস আছে না?"

যাইহোক, ব্যক্তিগতভাবে, আমি "আমরা" পছন্দ করি। এবং আমি নিজেও ভাবছি যে আমি কেন আমার সংস্থার একমাত্র কর্মচারী বিবেচনা করে আমরা আপ-স্ট্রিম নথিতে, এমনকি কোডেও না লিখি।

তবে আমি নিজে এবং আমি একমত যে এইভাবে আমরা কম নিঃসঙ্গতা অনুভব করব :)


1

আমি কি কেবলমাত্র "আমরা" লেখি এবং "আমাকে এবং কম্পিউটার" (বা "আমার দল এবং কম্পিউটার") ভাবি? "আমরা" বাইরের আমাদের যে অনুরোধটি দিয়েছিল তা পরিচালনা করতে চলেছি, এর অর্থ "আমাদের" ব্যবসায়ের প্রয়োজনীয়তার উপর ভিত্তি করে অনুরোধটি পড়তে হবে, কিছু উইন্ডো খুলতে হবে, কিছু গণনা করতে হবে। এটি আপনার পক্ষের অংশ হিসাবে কোডটি দেখতে সহায়তা করে, শত্রু নয় :-)


0

সংক্ষিপ্ত মন্তব্যের জন্য, আমি মাঝে মাঝে দ্বিতীয় ব্যক্তিতে লিখি, যেন আমি অন্য কাউকে নির্দেশ দিচ্ছি, প্রায় পরবর্তী বিকাশকারীকে মন্তব্যটি পড়ার নির্দেশিত বার্তা হিসাবে। যেমন

//You can get a session_id from SYSSession.getSessionID() if you need one

দীর্ঘ মন্তব্য (যেমন একটি দীর্ঘ ফাংশন শিরোলেখ বা অ্যালগোরিদমের বিবরণের বেশ কয়েকটি লাইন) আমি নিরপেক্ষ, কোনও প্রথম ব্যক্তি, দ্বিতীয় ব্যক্তি বা তৃতীয় ব্যক্তি হিসাবে রাখার চেষ্টা করি।


ইংরেজি প্যাসিভ খুব কমই ভাল শোনাচ্ছে: "একজন SESSION_ID SYSSession.getSessionID () যদি এক প্রয়োজন হয় থেকে অর্জিত যাবে না"
jkj

0

আপনি এই মন্তব্যটি যুক্ত করেছেন কারণ কোডটি যথেষ্ট পরিমাণে পরিষ্কার ছিল না। আমি সাধারণত ভাল সংজ্ঞায়িত পদ্ধতির মাধ্যমে অভিব্যক্তি প্রকাশ করার মতামত ব্যবহারকে এড়িয়ে চলি। উদাহরণস্বরূপ, এই লাইনটি কোনও নামকরণ পদ্ধতিতে স্থানান্তরিত করা যেতে পারে CanThisFormBeResized

একটি ছোট নামী পদ্ধতি যদিও ছোট, একটি মন্তব্যকে মারধর করে কারণ মন্তব্য এবং কোড সিঙ্কের বাইরে চলে যাওয়া সহজ।

সুতরাং, যদি বেশিরভাগ মন্তব্যে কোড প্রকাশ করা যায় তবে মন্তব্যগুলির খুব কম কারণ রয়েছে

  • যদি আপনার মন্তব্যটি আপনার মতামত হয়, তবে "আমি" দিয়ে শুরু করুন
  • যদি আপনি ভাবেন যে আপনার মন্তব্যটি একটি ভাগ করা মতামত হওয়া উচিত (উদাহরণস্বরূপ সেরা অনুশীলন), তবে "আমরা" দিয়ে শুরু করুন
  • যদি আপনার মন্তব্যটি অর্ধ-বুদ্ধি দ্বারা রচিত কোনও ছদ্মবেশী কোডে নির্দেশিত হয় , তবে মন্তব্যটি স্ক্র্যাপ করুন এবং উপরে হাঁটুন এবং তাদের সহকর্মীর কাছ থেকে বিভ্রান্তিকর কোডটি ঘুষি মারুন, তারপরে তাদের সাথে এই মুখোমুখি সম্বোধন করুন।

1
দুঃখিত, তবে আমি এই স্টাইলের মোটেই ভক্ত নই। বিশেষত যেহেতু এই কোডটি একবারে, এক জায়গায় ব্যবহার করা হয়েছে এবং পুনরায় আকার দেওয়ার পদ্ধতিতে এটি ইতিমধ্যে একমাত্র জিনিস। আমি রিফ্যাক্টরিংয়ের মাধ্যমে জটিলতা যুক্ত করার জন্য একটি সংক্ষিপ্ত, ভাল কথার মন্তব্যটি পছন্দ করব, বিশেষত ভিবি 6 ডিবাগারের সাথে কাজ করার সময়। একটি সরু হিসাবে, CanThisFormBeResizedসম্ভবত ThisFormCanBeResizedএটি ব্যবহার করা যাচ্ছে যদি হওয়া উচিত If ThisFormCanBeResized Then
dlras2

1
পছন্দ পছন্দ। আমি function() { return this.windowState != 1 }কোনও মন্তব্য মত একটি বেসরকারী বুলিয়ান পদ্ধতি গ্রহণ । আমার কাছ থেকে +1
কেপলা

1
@ ড্যান, পরে যদি অন্য কেউ আসে তবে কী হবে: উইন্ডোটি ছোট করা যায় কিনা তা নির্ধারণ করার জন্য কেন তাদের চারপাশে অনুসন্ধান করুন এবং যুক্তিটি পুনরায় চিত্রিত করবেন? তারা আপনার মন্তব্যে আপনার কোডের সামান্য লাইনটি স্পট না করে এবং তাদের নিজস্ব যুক্ত করতে পারে। এখন আপনার কাছে 2 টি জায়গা রয়েছে যা যুক্তির পরিবর্তিত হলে পরিবর্তনগুলি প্রয়োজন এবং 2 টি জায়গা যেখানে মন্তব্যগুলি কোডের সাথে সিঙ্কের বাইরে চলে যেতে পারে। কেন একটি নামযুক্ত 1 লাইন পদ্ধতি (যা রাষ্ট্র পরিবর্তন করে না) যুক্ত করা জটিলতা? এটি সর্বাধিক সর্বাধিক সহজ এবং পরিষ্কার-পরিচ্ছন্নতার একটি।
স্টিভ ডান

0

থাম্বের নিয়ম হিসাবে আমি প্রথম ব্যক্তিকে ব্যবহার করার পরামর্শ দেব, এটি I

কেন? আমার স্বভাবের স্বভাবের কারণে নয়, কারণ লোকেরা যখন অন্য কোনও দৃষ্টিকোণে কথা বলে, তখন তারা অনেক বেশি শব্দ ব্যবহার করে বা বাক্যগুলিকে জটিল করে তোলে এবং বিষয়গুলি ব্যাখ্যা করার চেষ্টায় হারিয়ে যায়। প্রথম ব্যক্তি সর্বদা পড়া সহজ হতে ঝোঁক।


0

ব্যক্তিগতভাবে আমি লিখি (সি # তে):

if (WindowState != WindowState.Minimised)
{
     ResizeWindowSafely();
}

বা এই লাইন বরাবর কিছু, সুতরাং মন্তব্যগুলির প্রয়োজন হয় না।


ResizeWindowSafelyএর অর্থ হ'ল এটি বলা যেতে পারে যে আপনি যদি আকার পরিবর্তন করতে চান না বা না জানেন এবং এভাবে if (WindowState != WindowState.Minimised)নিজেকে অন্তর্ভুক্ত করা দরকার ।
dlras2
আমাদের সাইট ব্যবহার করে, আপনি স্বীকার করেছেন যে আপনি আমাদের কুকি নীতি এবং গোপনীয়তা নীতিটি পড়েছেন এবং বুঝতে পেরেছেন ।
Licensed under cc by-sa 3.0 with attribution required.