bennyxqg / bulk-loader

Automatically exported from code.google.com/p/bulk-loader
0 stars 0 forks source link

Why don't you use the "private" identifier ? #80

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
Hello.

I have found lots of /** @private */ comments in code.

*suggestion*
Using private identifier is readable, compiler-friendly than @private comments.

Original issue reported on code.google.com by tanab...@gmail.com on 10 Mar 2009 at 5:31

GoogleCodeExporter commented 9 years ago
Hi Tanablog.

This is will take a while to explain, but I'll get to write a blog post about 
it sometime.
Short view: I don't see any reason to use private. I am not writing to 
compilers, but people.
BulkLoader had everything private at some point. From there on, it turn out 
that things were much more 
useful once they were public.

I mark internal var with an underscore and use the @private tag as those should 
not appear in the end user 
documentation (it's internal, and subject to change), but that's it.

Cheers
Arthur

Original comment by debert on 10 Mar 2009 at 12:28

GoogleCodeExporter commented 9 years ago
The @private tag does not avoid all those 
public_methods_that_are_private_actually to 
appear in any code completer IDE which makes developers able to make easy 
mistakes. 

Have you find time to write that blog post about it?

You could use a namespace to avoid private methods and keep things useful.

Still, bulkloader rocks!

Original comment by hdavid%l...@gtempaccount.com on 21 Jan 2010 at 7:17

GoogleCodeExporter commented 9 years ago
Hi Hadrien.

Sorry, not yet. Some of the ideas are hinted at here[1], but it's something 
that I'll still 
want to do. (I'll post it here, if you star the issue you'll get an email 
letting your know 
;)

Best reagards
Arthur

[1] http://groups.google.com/group/bulkloader-
users/browse_frm/thread/2cd73ab2111c1493/416e4c995a7c30fe?
lnk=gst&q=python+#416e4c995a7c30fe

Original comment by debert on 21 Jan 2010 at 11:27